Attempt to merge latest upstream #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

AxelTheGerman wants to merge 65 commits into acl-services:master from pythonicrubyist:master

.github/workflows/test.yml

-Original file line number
+Diff line change
@@ -0,0 +1,50 @@
+    # This workflow uses actions that are not certified by GitHub.
+    # They are provided by a third-party and are governed by
+    # separate terms of service, privacy policy, and support
+    # documentation.
+    # This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+    # For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+    name: Ruby
+    on:
+      push:
+        branches: [ "*" ]
+      pull_request:
+        branches: [ "*" ]
+    permissions:
+      contents: read
+    jobs:
+      lint:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v3
+          - name: Set up Ruby
+            uses: ruby/setup-ruby@v1
+            with:
+              ruby-version: "3.1"
+              bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          - name: Run lint
+            run: bundle exec rubocop
+      test:
+        runs-on: ubuntu-latest
+        strategy:
+          matrix:
+            ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2']
+        needs:
+          - lint
+        steps:
+        - uses: actions/checkout@v3
+        - name: Set up Ruby
+          uses: ruby/setup-ruby@v1
+          with:
+            ruby-version: ${{ matrix.ruby-version }}
+            bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+        - name: Run tests
+          run: bundle exec rake

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -15,3 +15,8 @@ spec/reports @@
     test/tmp
     test/version_tmp
     tmp
+    # Mac finder artifacts
+    .DS_Store
+    .idea

.rubocop.yml

-Original file line number
+Diff line change
@@ -0,0 +1,27 @@
+    Gemspec/RequiredRubyVersion:
+      Enabled: false
+    Layout/LineLength:
+      Enabled: false
+    Metrics:
+      Enabled: false
+    Naming/ConstantName:
+      Enabled: false
+    Style/FrozenStringLiteralComment:
+      Enabled: false
+    Style/Documentation:
+      Enabled: false
+    Style/AndOr:
+      Enabled: false
+    Style/StringConcatenation:
+      Enabled: false
+    Style/ClassAndModuleChildren:
+      Enabled: false
+    Style/OptionalBooleanParameter:
+      Enabled: false
+    Style/TernaryParentheses:
+      EnforcedStyle: require_parentheses_when_complex
+    Naming/PredicateName:
+      Enabled: false

LICENSE.txt

-Original file line number
+Diff line change
@@ -1,4 +1,4 @@
-    Copyright (c) 2013 TODO: Write your name
+    Copyright (c) 2017 Ramtin Vaziri https://www.ramtin-vaziri.com
     MIT License
@@ Expand All @@
     LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
     OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+    https://ramtin-vaziri.com

README.md

-Original file line number
+Diff line change
@@ -0,0 +1,142 @@
+    [![version](https://badge.fury.io/rb/creek.svg)](https://badge.fury.io/rb/creek)
+    [![downloads](https://img.shields.io/gem/dt/creek)](https://rubygems.org/gems/creek)
+    # Creek - Stream parser for large Excel (xlsx and xlsm) files.
+    Creek is a Ruby gem that provides a fast, simple and efficient method of parsing large Excel (xlsx and xlsm) files.
+    ## Installation
+    Creek can be used from the command line or as part of a Ruby web framework. To install the gem using terminal, run the following command:
+    ```
+    gem install creek
+    ```
+    To use it in Rails, add this line to your Gemfile:
+    ```ruby
+    gem 'creek'
+    ```
+    ## Basic Usage
+    Creek can simply parse an Excel file by looping through the rows enumerator:
+    ```ruby
+    require 'creek'
+    creek = Creek::Book.new 'spec/fixtures/sample.xlsx'
+    sheet = creek.sheets[0]
+    sheet.rows.each do |row|
+      puts row # => {"A1"=>"Content 1", "B1"=>nil, "C1"=>nil, "D1"=>"Content 3"}
+    end
+    sheet.simple_rows.each do |row|
+      puts row # => {"A"=>"Content 1", "B"=>nil, "C"=>nil, "D"=>"Content 3"}
+    end
+    sheet.rows_with_meta_data.each do |row|
+      puts row # => {"collapsed"=>"false", "customFormat"=>"false", "customHeight"=>"true", "hidden"=>"false", "ht"=>"12.1", "outlineLevel"=>"0", "r"=>"1", "cells"=>{"A1"=>"Content 1", "B1"=>nil, "C1"=>nil, "D1"=>"Content 3"}}
+    end
+    sheet.simple_rows_with_meta_data.each do |row|
+      puts row # => {"collapsed"=>"false", "customFormat"=>"false", "customHeight"=>"true", "hidden"=>"false", "ht"=>"12.1", "outlineLevel"=>"0", "r"=>"1", "cells"=>{"A"=>"Content 1", "B"=>nil, "C"=>nil, "D"=>"Content 3"}}
+    end
+    sheet.state   # => 'visible'
+    sheet.name    # => 'Sheet1'
+    sheet.rid     # => 'rId2'
+    ```
+    ## Filename considerations
+    By default, Creek will ensure that the file extension is either *.xlsx or *.xlsm, but this check can be circumvented as needed:
+    ```ruby
+    path = 'sample-as-zip.zip'
+    Creek::Book.new path, :check_file_extension => false
+    ```
+    By default, the Rails [file_field_tag](http://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-file_field_tag) uploads to a temporary location and stores the original filename with the StringIO object. (See [this section](http://guides.rubyonrails.org/form_helpers.html#uploading-files) of the Rails Guides for more information.)
+    Creek can parse this directly without the need for file upload gems such as Carrierwave or Paperclip by passing the original filename as an option:
+    ```ruby
+    # Import endpoint in Rails controller
+    def import
+      file = params[:file]
+      Creek::Book.new file.path, check_file_extension: false
+    end
+    ```
+    ## Parsing images
+    Creek does not parse images by default. If you want to parse the images,
+    use `with_images` method before iterating over rows to preload images information. If you don't call this method, Creek will not return images anywhere.
+    Cells with images will be an array of Pathname objects.
+    If an image is spread across multiple cells, same Pathname object will be returned for each cell.
+    ```ruby
+    sheet.with_images.rows.each do |row|
+      puts row # => {"A1"=>[#<Pathname:/var/folders/ck/l64nmm3d4k75pvxr03ndk1tm0000gn/T/creek__drawing20161101-53599-274q0vimage1.jpeg>], "B2"=>"Fluffy"}
+    end
+    ```
+    Images for a specific cell can be obtained with images_at method:
+    ```ruby
+    puts sheet.images_at('A1') # => [#<Pathname:/var/folders/ck/l64nmm3d4k75pvxr03ndk1tm0000gn/T/creek__drawing20161101-53599-274q0vimage1.jpeg>]
+    # no images in a cell
+    puts sheet.images_at('C1') # => nil
+    ```
+    Creek will most likely return nil for a cell with images if there is no other text cell in that row - you can use *images_at* method for retrieving images in that cell.
+    ## Remote files
+    ```ruby
+    remote_url = 'http://dev-builds.libreoffice.org/tmp/test.xlsx'
+    Creek::Book.new remote_url, remote: true
+    ```
+    ## Mapping cells with header names
+    By default, Creek will map cell names with letter and number(A1, B3 and etc). To be able to get cell values by header column name use ***with_headers*** (can be used only with ***#simple_rows*** method!!!) during creation *(Note: header column is first string of sheet)*
+    ```ruby
+    creek = Creek::Book.new file.path, with_headers: true
+    ```
+    ## Contributing
+    Contributions are welcomed. You can fork a repository, add your code changes to the forked branch, ensure all existing unit tests pass, create new unit tests which cover your new changes and finally create a pull request.
+    After forking and then cloning the repository locally, install the Bundler and then use it
+    to install the development gem dependencies:
+    ```
+    gem install bundler
+    bundle install
+    ```
+    Once this is complete, you should be able to run the test suite:
+    ```
+    rake
+    ```
+    There are some remote tests that are excluded by default. To run those, run
+    ```
+    bundle exec rspec --tag remote
+    ```
+    ## Bug Reporting
+    Please use the [Issues](https://github.com/pythonicrubyist/creek/issues) page to report bugs or suggest new enhancements.
+    ## License
+    Creek has been published under [MIT License](https://github.com/pythonicrubyist/creek/blob/master/LICENSE.txt)

README.rdoc

This file was deleted.

Rakefile

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,7 +1,7 @@
  
    require "bundler/gem_tasks"

    require 'bundler/gem_tasks'

    require 'rspec/core/rake_task'

    RSpec::Core::RakeTask.new('spec')

    # If you want to make this the default task

    task :default => :spec
      
    task default: :spec

creek.gemspec

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,30 +1,30 @@
  
    # coding: utf-8

    lib = File.expand_path('../lib', __FILE__)

    lib = File.expand_path('lib', __dir__)

    $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

    require 'creek/version'

    Gem::Specification.new do |spec|

      spec.name          = "creek"

      spec.name          = 'creek'

      spec.version       = Creek::VERSION

      spec.authors       = ["pythonicrubyist"]

      spec.email         = ["pythonicrubyist@gmail.com"]

      spec.description   = %q{A Ruby gem that streams and parses large Excel(xlsx and xlsm) files fast and efficiently.}

      spec.summary       = %q{A Ruby gem for parsing large Excel(xlsx and xlsm) files.}

      spec.homepage      = "https://github.com/pythonicrubyist/creek"

      spec.license       = "MIT"

      spec.authors       = ['pythonicrubyist']

      spec.email         = ['pythonicrubyist@gmail.com']

      spec.description   = 'A Ruby gem that streams and parses large Excel(xlsx and xlsm) files fast and efficiently.'

      spec.summary       = 'A Ruby gem for parsing large Excel(xlsx and xlsm) files.'

      spec.homepage      = 'https://github.com/pythonicrubyist/creek'

      spec.license       = 'MIT'

      spec.files         = `git ls-files`.split($/)

      spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)

      spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

      spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})

      spec.require_paths = ["lib"]

      spec.require_paths = ['lib']

      spec.required_ruby_version = '>= 1.9.2'

      spec.required_ruby_version = '>= 2.0.0'

      spec.add_development_dependency "bundler", "~> 1.3"

      spec.add_development_dependency "rake"

      spec.add_development_dependency 'rspec', '~> 2.13.0'

      spec.add_development_dependency 'pry'

      spec.add_development_dependency 'bundler'

      spec.add_development_dependency 'pry-byebug'

      spec.add_development_dependency 'rake'

      spec.add_development_dependency 'rspec', '~> 3.6.0'

      spec.add_development_dependency 'rubocop'

      spec.add_dependency 'nokogiri', '~> 1.6.0'

      spec.add_dependency 'nokogiri', '>= 1.10.0'

      spec.add_dependency 'rubyzip', '>= 1.0.0'

    end

lib/creek.rb

-Original file line number
+Diff line change
@@ -1,9 +1,13 @@
-    require "creek/version"
+    # frozen_string_literal: true
+    require 'creek/version'
     require 'creek/book'
     require 'creek/styles/constants'
     require 'creek/styles/style_types'
     require 'creek/styles/converter'
+    require 'creek/utils'
     require 'creek/styles'
+    require 'creek/drawing'
     require 'creek/sheet'
     require 'creek/shared_strings'
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Attempt to merge latest upstream #12

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Attempt to merge latest upstream #12

Are you sure you want to change the base?

Uh oh!

Attempt to merge latest upstream #12

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!