makesheets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23dfb980e5760ee8f81e92cef3e61d818d9a5c9a
+  data.tar.gz: 31452b0014bc25eda438949b77a08bf92eb3ebc3
+SHA512:
+  metadata.gz: 912c249506e52257e64528a4ce2e332d53f441a114c5b8e2259d271a6952d3d4f800a4e3c89dca06ff64731281b6d1aa9629acc966d68a9b960305acdb5ec232
+  data.tar.gz: e9e5072b9f08f5e2c06fb9358fd3e03fe6b7563ee2faa44236eaf9e41539de8c3c609d5c8fcded05bd352324e95584816f11ebfd25f5e1e62d20235e36e5642f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jeyaraj.durairaj@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in makesheets.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jeyaraj
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE 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.

data/README.md

@@ -0,0 +1,41 @@
+# Makesheets
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/makesheets`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'makesheets'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install makesheets
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/makesheets. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "makesheets"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/makesheets

@@ -0,0 +1,38 @@
+require 'makesheets'
+require 'optparse'
+
+options = {}
+option_parser = OptionParser.new do |opts|
+    opts.on("-i", "--infile INFILE", 
+            "Requires Input file path") do |infile|
+        options[:infile] = infile
+    end
+    opts.on("-s", "--sheet SHEET", 
+            "[Infile sheet name]") do |sheet|
+        options[:sheet] = sheet
+    end
+    opts.on("-k", "--skiprows SKIPROWS", 
+            "Number of rows to skip while reading infile") do |skiprows|
+        options[:skiprows] = skiprows
+    end
+    opts.on("-r", "--readrows READABLEROWS", 
+            "Number of rows to be read from infile") do |readrows|
+        options[:readrows] = readrows
+    end
+    opts.on("-o", "--outfile OUTFILE", 
+            "[Optional outfile path]") do |outfile|
+        options[:outfile] = outfile
+    end
+    opts.on("-c", "--column COLUMN", 
+            "<string>Column header by which sheets to be generated") \
+                                                    do |column|
+        options[:column] = column
+    end
+    opts.on("-p", "--prefix PREFIX", 
+            "[Prefix of generated sheets' name]") do |prefix|
+        options[:prefix] = prefix
+    end
+end
+
+option_parser.parse!
+Makesheets.run(options)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/makesheets.rb

@@ -0,0 +1,38 @@
+require "makesheets/version"
+require 'makesheets/validator'
+require 'makesheets/processor'
+
+#= Entry point, which validates and deligates the task
+module Makesheets
+
+    # Validator and Delegator
+    def self.run(options)
+        #puts options.inspect
+        unless options[:infile]
+            puts "[Error]: File path of the spreadsheet is required"
+            exit
+        end
+        unless options[:column]
+            puts "[Error]: Key column name must be given"
+            exit
+        end
+        unless Validator::FileValidator.new(options[:infile]).validate
+            puts "[Error]: #{options[:infile]} is not a valid infile!!!"
+            exit
+        end
+        if options[:outfile]
+            unless Validator::FileValidator.new(options[:outfile]).validate
+                puts "[Error]: #{options[:outfile]} is not a valid outfile!!!"
+                exit
+            end
+        end
+        if options[:skiprows]
+            options[:skiprows] = options[:skiprows].to_i
+        end
+        if options[:readrows]
+            options[:readrows] = options[:readrows].to_i
+        end
+        Processor.new(options).process
+    end
+
+end

data/lib/makesheets/exceptions/validate.rb

@@ -0,0 +1,13 @@
+#= Makesheets specific exception classes
+class ColumnNotFoundError < StandardError
+
+    attr_reader :column, :filename
+
+    def initialize(column, filename, 
+                   msg="[Error]: Queryable Excel column does not exist")
+        @column = column
+        @filename = filename
+        super(msg)
+    end
+
+end

data/lib/makesheets/processor.rb

@@ -0,0 +1,53 @@
+require 'makesheets/reader'
+require 'makesheets/writer'
+require 'makesheets/exceptions/validate'
+# ==== Assembles all the required classes and processes
+#
+# === Reads from Excel file
+# === Maps the matched data into the original base file
+class Processor
+
+    def initialize(options)
+        @infile = options[:infile]
+        @outfile = options[:outfile] || make_desti_file_name
+        @source_sht = options[:sheet] || 0
+        @skiprows = options[:skiprows] || 0
+        @readrows = options[:readrows]
+        @shtcol = options[:column]
+        @prefix = options[:prefix]
+    end
+
+    # Makes destination file name from source file name
+    def make_desti_file_name
+        folder, file = File.split(@infile)
+        extn = file[-5..-1]
+        new_file = file[0..-6] + '_Result' + extn
+        File.join(folder, new_file)
+    end
+
+    # Executes the process
+    def process
+        puts "[Info]: Process initiated..."
+        @source = ExcelReader.new(@infile, @source_sht, @skiprows, 
+                                  @readrows, @shtcol)
+        unless column_exists? # Validates if the makesheet column exists
+            begin
+                raise ColumnNotFoundError.new(@shtcol, @infile)
+            rescue => e
+                puts "#{e.column} column does not exist in #{e.filename}!!!"
+            end
+            exit
+        end
+        @source.read
+        ExcelWriter.new(@outfile, @source, @shtcol, @prefix).write
+    end
+
+
+    def column_exists?
+        @source.headers.include?(@shtcol)
+    end
+
+    private :make_desti_file_name, :column_exists?
+    public :process
+
+end

data/lib/makesheets/reader.rb

@@ -0,0 +1,58 @@
+require 'roo'
+
+# Contains functionalities for reading content from Excel
+class ExcelReader
+
+    attr_reader :data, :headers, :data_shtcols
+
+    def initialize(filename, sheet, skiprows, readrows, shtcol) #:notnew:
+        @filename = filename
+        @shtcol = shtcol
+        @data = []
+        @data_shtcols = [] # container to hold all unique data of makesheet col
+        set_file_credentials(sheet, skiprows, readrows)
+    end
+
+    # Sets last_row, last_column, headers, etc
+    def set_file_credentials(sht, skip, read)
+        puts "[Info]: Validation & setting file credentials are on progress..."
+        @sht = Roo::Excelx.new(@filename).sheet(sht)
+        @lrow = @sht.last_row
+        @lcol = @sht.last_column
+        @skiprows = skip
+        @headers = @sht.row(@skiprows+1)
+        @readrows = read ? read+@skiprows : @lrow
+    end
+
+    # Iterates over rows and stores the data as list of hashes
+    def read
+        puts "[Info]: Data reading on progress..."
+        @lrow.times do |i|
+            row_idx = i + 1
+            next if row_idx <= @skiprows+1
+            row_data = @sht.row(row_idx)
+            row_dict = {}
+            @headers.each_with_index do |h, j|
+                temp_dict = { h => row_data[j] }
+                @data_shtcols << row_data[j] if h == @shtcol
+                row_dict.merge!(temp_dict)
+            end
+            @data << row_dict
+            break if row_idx > @readrows
+        end
+        len_before = @data_shtcols.length
+        @data_shtcols.uniq!
+        len_after = @data_shtcols.length
+        puts "[Info]: Column data count=#{len_before} [Bef] #{len_after} [Aft]"
+    end
+
+    private :set_file_credentials
+    public :read
+end
+
+
+
+
+
+
+

data/lib/makesheets/validator.rb

@@ -0,0 +1,24 @@
+# === Common module contains all Validation classes
+
+module Validator
+    # == Class container to validate files
+    class FileValidator
+
+        def initialize(file_name) #:notnew:
+            @file_name = file_name
+        end
+
+        # Validates and returns true or false 
+        #
+        # Uses the Standard File class method file
+        #
+        #   valid = Validator::File(file_name)
+        #   valid.validate
+        def validate
+            File.file?(@file_name)
+        end
+
+    end
+
+end
+

data/lib/makesheets/version.rb

@@ -0,0 +1,3 @@
+module Makesheets
+  VERSION = "0.1.0"
+end

data/lib/makesheets/writer.rb

@@ -0,0 +1,80 @@
+require 'rubyXL'
+
+# == Container for Excel writing functionalities
+class ExcelWriter
+    attr_reader :data, :data_shtcols
+
+    def initialize(filename, reader, shtcol, prefix) #:notnew:
+        @filename = filename
+        @data = reader.data
+        @headers = reader.headers
+        @data_shtcols = reader.data_shtcols
+        @shtcol = shtcol
+        @prefix = prefix
+        @is_header_written = {}
+        @wb = RubyXL::Workbook.new
+        @main_sht = @wb.worksheets[0]
+    end
+
+    # Executes Write action
+    def write
+        puts "[Info]: Writing headers in main sheet..."
+        write_header(@main_sht) # Write header in main sheet
+        puts "[Info]: Core data writing initiated"
+        write_data
+        @wb.write(@filename)
+        puts "[Info]: Result file has been written to #{@filename}"
+    end
+
+    # Writes in main sheet with all the data
+    def write_main row, col, val
+        @main_sht.add_cell(row, col, val)
+    end
+
+    # Writes column headers in a given sheet
+    def write_header sht 
+        @headers.each_with_index do |h, i|
+            sht.add_cell(0, i, h)
+        end
+    end
+
+    # Writes the records/data
+    def write_data
+        @data.each_with_index do |d, i|
+            d.each_with_index do |(k, v), j|
+               write_main(i+1, j, v)
+            end
+            write_individual(d, i+1)
+        end
+    end
+
+    # Make sheets and write for the unique data
+    # ---
+    # Excel accepts only 30 max characters as sheet name
+    def write_individual d, row
+        _key = d[@shtcol]
+        key_data = _key.instance_of?(Fixnum) ? _key.to_s : _key
+        sht_name = @prefix ? @prefix + '_' + key_data : key_data
+        if sht_name.length > 30 # In case sheet name is greater than 30 chars
+            slice_len = sht_name.length - 30 + 1
+            sht_name = sht_name.slice(-slice_len..slice_len)
+        end
+        sht = @wb[sht_name] ? @wb[sht_name] : @wb.add_worksheet(sht_name)
+        unless @is_header_written.has_key?(key_data)
+            write_header(sht)
+            @is_header_written[key_data] = { 
+                :header => true, 
+                :row => 1
+            }
+        end
+        d.each_with_index do |(k, v), j|
+            sht.add_cell(@is_header_written[key_data][:row], j, v)
+        end
+        @is_header_written[key_data][:row] += 1
+    end
+
+    private :write_header, :write_data, :write_main, :write_individual
+    public :write
+
+end
+

data/makesheets.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'makesheets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "makesheets"
+  spec.version       = Makesheets::VERSION
+  spec.authors       = ["Jeyaraj"]
+  spec.email         = ["jeyaraj.durairaj@gmail.com"]
+
+  spec.summary       = %q{Makes sheets based on Excel Column Data.}
+  spec.description   = %q{Based on unique value of a column, it creates sheets.}
+  spec.homepage      = "https://github.com/jeydurai"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+    #raise "RubyGems 2.0 or newer is required to protect against " \
+      #"public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files << "lib/makesheets.rb"
+  spec.files << "lib/makesheets/processor.rb"
+  spec.files << "lib/makesheets/reader.rb"
+  spec.files << "lib/makesheets/writer.rb"
+  spec.files << "lib/makesheets/validator.rb"
+  spec.files << "lib/makesheets/exceptions/validate.rb"
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables << 'makesheets' 
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "roo", "~> 2.7", ">= 2.7.1"
+  spec.add_development_dependency "rubyXL", "~> 3.3", ">= 3.3.26"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: makesheets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeyaraj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.26
+description: Based on unique value of a column, it creates sheets.
+email:
+- jeyaraj.durairaj@gmail.com
+executables:
+- console
+- makesheets
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/makesheets
+- bin/setup
+- lib/makesheets.rb
+- lib/makesheets/exceptions/validate.rb
+- lib/makesheets/processor.rb
+- lib/makesheets/reader.rb
+- lib/makesheets/validator.rb
+- lib/makesheets/version.rb
+- lib/makesheets/writer.rb
+- makesheets.gemspec
+homepage: https://github.com/jeydurai
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Makes sheets based on Excel Column Data.
+test_files: []