dreader 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be77a7a58ae4abcdcba7d3b734bc64f2cf756efd34bab78c30a4b0633fa6027a
+  data.tar.gz: d06cc4188e57c2e93297cece38b09b992cfeacad1f8cbbe6e645534965c45f4d
+SHA512:
+  metadata.gz: b3cbaeb434fea0a8f3c7dafcf2a096fd28b18deef69e66360be27eeff4cd8b0b42ea0f080f3fab85f01f26c90f4ce35424668fac855d15f6f0be8c1f25a9bc9c
+  data.tar.gz: 4da7939fa5e05ae685ad21f21a120067f4e4ddb5370b8171a37a7c00407f69300b162f0779cb69816ce3f8141f606c992226bf1125428911f1b7cd5dcb8a6b8d

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dreader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Adolfo Villafiorita
+
+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,117 @@
+# Dreader
+
+A simple DSL built on top of `roo` to read and process tabular data (CSV,
+LibreOffice, Excel).
+
+Use this gem to specify the structure of some tabular data you want to
+process.  The input data can be in CSV, LibreOffice, and Excel.  Each row can
+then be passed to a block of code you define.
+
+The gem can thus be used to check, process, import data. We use it to import data into
+Rails application, but the gem can used in any Ruby application.
+
+The gem should be relatively easy to use, despite its name: *dread* stands for
+*d*ata *r*eader.
+
+The gem depends on `roo`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dreader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dreader
+
+## Usage
+
+```
+i = Dreader::Engine.new
+
+i.options do
+  start_at 1
+end
+
+# first column is called name
+# :name should be non nil and of length greater than 0
+i.column :name do
+  check do |x|
+    x and x.length > 0
+  end
+end
+
+# second column is called surname
+# :surname should be non nil and of length greater than 0
+i.column :surname do
+  check do |x|
+    x and x.length > 0
+  end
+end
+
+# third column is called birthdate
+# :name should be non nil and of length greater than 0
+i.column :birthdate do
+  check do |x|
+    x.class == Date
+  end
+end
+
+# fourth column is called age
+# we make it into an integer
+# age should be greater than 0
+i.column :age do
+  process do |r|
+    r.to_i
+  end
+
+  check do |r|
+    r > 0
+  end
+end
+
+# when we decide to process the file, for every row
+# we print the value of the name and the value of the surname
+i.mapping do |r|
+  puts "#{r[:name][:value]} #{r[:surname][:value]}"
+end
+
+i.read "/home/adolfo/Desktop/a.ods"
+i.process
+```
+
+## Known Bugs and Limitations
+
+No known bugs and an unknown number of unknown bugs.
+
+(See the open issues for the known bugs.)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/avillafiorita/dreader.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dreader"
+
+# 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/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/dreader.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dreader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dreader"
+  spec.version       = Dreader::VERSION
+  spec.authors       = ["Adolfo Villafiorita"]
+  spec.email         = ["adolfo.villafiorita@ict4g.net"]
+
+  spec.summary       = %q{Process and import data from cvs and spreadsheets}
+  spec.description   = %q{Use this gem to specify the structure of some tabular data
+you want to process.  The input data can be in CSV, LibreOffice, and Excel.  Each row
+can then be passed to a block of code you define.
+
+The gem can thus be used to check, process, import data. We use it to import data into
+Rails application, but the gem can used in any Ruby application.
+
+The gem should be relatively easy to use, despite its name. (Dread
+stands for *d*ata *r*eader)}
+  spec.homepage      = "http://github.com/avillafiorita/dreader"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "roo"
+end

data/lib/dreader/version.rb

@@ -0,0 +1,3 @@
+module Dreader
+  VERSION = "0.1.1"
+end

data/lib/dreader.rb

@@ -0,0 +1,151 @@
+require "dreader/version"
+
+module Dreader
+  # service class to implement the column DSL language
+  class Column
+    def process &block
+      @process = block
+    end
+
+    def check &block
+      @check = block
+    end
+
+    def to_hash
+      {process: @process, check: @check }
+    end
+  end
+
+  # service class to implement the options DSL language
+  class Options
+    def initialize
+      @attributes = {}
+    end
+
+    def method_missing(name, *args, &block)
+      @attributes[name] = args[0]
+    end
+
+    def to_hash
+      @attributes
+    end
+  end
+
+  #
+  # This is where the real stuff begins
+  #
+  class Engine
+    
+    # readable for debugging purposes
+    # the options we passed 
+    attr_reader :options
+    # the specification of the columns to process
+    attr_reader :colspec
+    # the data we read
+    attr_reader :array
+
+    def initialize
+      @options = {}
+      @colspec = []
+    end
+
+    # define a DSL for options
+    # any string is processed as an option and it ends up in the
+    # @options hash
+    def options &block
+      options = Options.new
+      options.instance_eval(&block)
+
+      @options = options.to_hash
+    end
+
+    # define a DSL for column specification
+    # - `name` is the name of the column
+    # - `block` contains two declarations, `process` and `check`, which are
+    #   used, respectively, to make a cell into the desired data and to check
+    #   whether the desired data is ok
+    def column name, &block
+      column = Column.new
+      column.instance_eval(&block)
+
+      @colspec << column.to_hash.merge({name: name})
+    end
+
+    # define what we do with each line we read
+    # - `block` is the code which takes as input a `row` and processes
+    #   `row` is a hash in which each spreadsheet cell is accessible under
+    #   the column names. Each cell has the following values:
+    #   :value, :error, :row_number, :col_number
+    def mapping &block
+      @mapping = block
+    end
+
+    # read a file and store it internally
+    # return the data we read in the form of an array of hashes
+    def read filename=nil
+      spreadsheet = self.open_spreadsheet filename || @options[:filename]
+      sheet = spreadsheet.sheet(@options[:sheet] || 0)
+
+      @array = Array.new
+      @errors = Array.new
+      first_row = @options[:start_at] || 1
+      (first_row..spreadsheet.last_row).each do |row_number|
+        row = spreadsheet.row(row_number)
+
+        r = Hash.new
+        @colspec.each_with_index do |colspec, index|
+          colname = colspec[:name]
+
+          r[colname] = Hash.new
+
+          r[colname][:row_number] = row_number
+          r[colname][:col_number] = index + 1
+
+          r[colname][:value] = value = colspec[:process] ? colspec[:process].call(row[index]) : row[index]
+
+          if colspec[:check] and not colspec[:check].call(value) then
+            r[colname][:error] = true
+            @errors << "Error: value \"#{row[index]}\" for #{colname} at row #{row_number} (col #{index + 1}) is incorrect"
+          else
+            r[colname][:error] = false
+          end
+        end
+
+        @array << r
+      end
+
+      @array
+    end
+
+    # return an array of strings with all the errors we have encounterd
+    # an empty array is a good news
+    def errors
+      @errors
+    end
+
+    # apply the mapping code to the array
+    # it makes sense to invoke it only 
+    def process
+      @array.each do |r|
+        @mapping.call(r)
+      end
+    end
+
+    def to_s
+      @array.to_s
+    end
+
+    private
+
+    def self.open_spreadsheet(filename)
+      case File.extname(filename)
+      when ".csv" then Csv.new(filename)
+      when ".ods" then Roo::OpenOffice.new(filename)
+      when ".xls" then Roo::Excel.new(filename)
+      when ".xlsx" then Roo::Excelx.new(filename)
+      else raise "Unknown file type: #{filename}"
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: dreader
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Adolfo Villafiorita
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Use this gem to specify the structure of some tabular data
+  you want to process.  The input data can be in CSV, LibreOffice, and Excel.  Each row
+  can then be passed to a block of code you define.
+
+  The gem can thus be used to check, process, import data. We use it to import data into
+  Rails application, but the gem can used in any Ruby application.
+
+  The gem should be relatively easy to use, despite its name. (Dread
+  stands for *d*ata *r*eader)
+email:
+- adolfo.villafiorita@ict4g.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dreader.gemspec
+- lib/dreader.rb
+- lib/dreader/version.rb
+homepage: http://github.com/avillafiorita/dreader
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Process and import data from cvs and spreadsheets
+test_files: []