ditch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3022fc85efcdf439b3c74765cf0df239dceb3ba
+  data.tar.gz: 3ef2f99862fe223e604d236f966274c4f6dbc9c9
+SHA512:
+  metadata.gz: 7ebb597244a64067cf48aa384b74372f28ea858fc5a61a7b5c22312e9306b07016afa7e843b13ca7f6c18e2b04e859382378fd98f09a1544df4de4b668a93832
+  data.tar.gz: 9d7ed7ef72c27d629acfe740773aa24b7d713442fb52bea5b0db62f2ead9a22b3fda2a9acbd0162a9408626e016ab2e88b137185f7faa972f5176c7d828225e2

data/.gitignore

@@ -0,0 +1,54 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+*.gem
+.idea
+
+### Vim template
+# swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-v][a-z]
+[._]sw[a-p]
+# session
+Session.vim
+# temporary
+.netrwhist
+*~
+# auto-generated tag files
+tags
+### macOS template
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+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 thorsager@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,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ditch.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michael Thorsager
+
+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,62 @@
+# Ditch
+
+Just adding a few bits and peaces onto the [Creek](https://github.com/pythonicrubyist/creek) Ruby gem.
+Nothing major just small things to make using the gem a bit more convenient, for my use anyway.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ditch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ditch
+
+## Usage
+
+```ruby
+require 'ditch'
+
+begin
+  book = Ditch::Book.new 'resources/testing.xlsx'
+  
+  # Reading all data 
+  sheet = book.sheet(0)
+  sheet.rows.each { |r|
+    puts "#{r.index} #{r.get('A')} - #{r.get('b')}"
+  }
+ 
+  # Process first row as Headers
+  sheet = book.sheet(0, :first_row_is_header=>true)
+  sheet.rows.each { |r|
+    puts "#{r.lookup('Name')} is #{r.lookup('Age')} years old"
+  }
+
+rescue StandardError => e
+  $stderr.puts(e.message)
+end
+
+```
+
+## 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/thorsager/ditch. 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 "ditch"
+
+# 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/ditch.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ditch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ditch'
+  spec.version       = Ditch::VERSION
+  spec.authors       = ["Michael Thorsager"]
+  spec.email         = ["thorsager@gmail.com"]
+
+  spec.summary       = %q{Extends the Creek gem, for ease of use}
+  spec.description   = %q{This adds some functions onto the Creek gem, that makes it a bit easier to work with spreadsheets}
+  spec.homepage      = 'https://github.com/thorsager/ditch'
+  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.required_ruby_version = '>= 1.9.2'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency 'creek', '~> 1.1', '>= 1.1.1'
+end

data/lib/ditch.rb

@@ -0,0 +1,12 @@
+require 'ditch/version'
+require 'ditch/book'
+require 'ditch/sheet'
+require 'ditch/indexed_row'
+
+module Ditch
+  # Your code goes here...
+
+  # Generic Exception
+  class DitchError < StandardError
+  end
+end

data/lib/ditch/book.rb

@@ -0,0 +1,14 @@
+require 'creek'
+module Ditch
+
+  # Extends the Creek::Book
+  class Ditch::Book < Creek::Book
+    # Retrieve the Sheet on a given index in the Book
+    # * +number+ The sheet <i>number</i> within the Book
+    # * +options+ Options passed on to the Creation of the Ditch::Sheet
+    def sheet(number, options={})
+      Ditch::Sheet.new sheets[number],  options
+    end
+  end
+
+end

data/lib/ditch/indexed_row.rb

@@ -0,0 +1,54 @@
+module Ditch
+
+  # Class wrapping the data-structure used or Row data in Creek
+  class Ditch::IndexedRow
+    attr_reader :index, :creek_row
+
+    # Create instance of IndexedRow
+    # * +headers+ Array holding column-headers
+    # * +index+ Row Index in the sheet
+    # * +data+ The original <i>creek row</i>
+    def initialize (headers,index, data)
+      @headers = headers
+      @index = index
+      @creek_row = data
+    end
+
+    # Get cell value from column-designation
+    # * +cell+ column-designation such as 'A'
+    def get( cell )
+      creek_value = @creek_row["#{cell.upcase}#{@index}"]
+      (creek_value.nil? || creek_value == 'NULL' || creek_value.empty?) ? nil : creek_value
+    end
+
+    # Get cell value from 'header-title'
+    # * +title+ Sting describing column by <i>name</i>
+    def lookup( title )
+      raise Ditch::DitchError.new('No headers..') if @headers.nil?
+      cell = @headers[title]
+
+      raise Ditch::DitchError.new("Title '#{title}' not found in headers..") if cell.nil?
+      get cell.strip
+    end
+
+    # Test if cell non-nil value
+    # * +title+ String containing header-title of a column
+    def has_value?(title)
+      !lookup(title).nil?
+    end
+
+    # Format the row into a <i>human-readable</i> string
+    def to_s
+      if @headers.nil?
+        "#{@index}: #{@creek_row.to_s}"
+      else
+        parts = Array.new
+        @headers.each_key do |h|
+          parts << "'#{h}'=>'#{lookup(h)}'"
+        end
+        "#{@index}: {#{parts.join(', ')}}"
+      end
+    end
+
+  end
+end

data/lib/ditch/sheet.rb

@@ -0,0 +1,39 @@
+module Ditch
+  # Class wrapping the Creek::Sheet class for adding small things
+  class Ditch::Sheet
+    attr_reader :creek_sheet
+
+    # Create a Ditch::Sheet
+    # * +sheet+ Creek::Sheet to make the base
+    # * +options+ Options to control the behaviour of the sheet
+    def initialize(sheet,options={})
+      @creek_sheet = sheet
+      @opts = options
+      if @opts[:first_row_is_header]
+        @headers = headers
+      end
+    end
+
+    # Retrieve headers, if :first_row_is_header option is set
+    def headers
+      headers = Hash.new
+      header_row = @creek_sheet.rows.first
+      header_row.each_key do |k|
+        headers[header_row[k]]= k.gsub(/\d/,'')
+      end
+      headers
+    end
+
+    # Enumerate the Rows in the given Sheet, As Ditch::IndexedRows
+    def rows
+      Enumerator.new do |y|
+        @creek_sheet.rows.each_with_index do |row, index|
+          unless index == 0 && @opts[:first_row_is_header]
+            y << Ditch::IndexedRow.new(@headers, index+1, row)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/ditch/version.rb

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

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: ditch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Thorsager
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-19 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: creek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+description: This adds some functions onto the Creek gem, that makes it a bit easier
+  to work with spreadsheets
+email:
+- thorsager@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/ditch.iml"
+- ".idea/encodings.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/workspace.xml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ditch.gemspec
+- lib/ditch.rb
+- lib/ditch/book.rb
+- lib/ditch/indexed_row.rb
+- lib/ditch/sheet.rb
+- lib/ditch/version.rb
+homepage: https://github.com/thorsager/ditch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Extends the Creek gem, for ease of use
+test_files: []