rb-gust 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDI4MTRmNTY1NDgxN2M5MTBkYzRlMThkMjIwMDE5OTg3YmM0ZDVkNw==
+  data.tar.gz: !binary |-
+    ZGEzMjhkNWNhMWRjYzE5NWIxOTVkMTQ3MTlhMmY5Yzc1NzcyODRkYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OWFhMTQwZjY4OGE4NTQ1Zjk0N2MwZDA0MTVlMjllZjkxNzU1MjRmZTBhMjk4
+    MTc2OWU3ZjIyZDU2N2VmYTI3NWVlM2M4YjZkNzk3MTg5Y2Y3MWI5ZjMyY2Ew
+    MDc3Y2NmMTE3NTcyZTllZWVhMDU2ZDUyNmE1MGVjMDI1MTY3MmE=
+  data.tar.gz: !binary |-
+    NzMxMzI3ZjU3YjQ2M2U1ODg3M2Y1YmI0NGVlNWMwODg0YTU3NDljZTAxYzUx
+    YzMyY2E0NDM1MmU2OGM0NzM0MzVlMDc4NWJhMTQ2MDY4MWY5OWNkMDllNzFi
+    ZmQ5MjQwN2MxODY2NGNiMThmZTVkNjYyMzBmMTViZjY1ZGRlNjI=

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/FORECAST.md

@@ -0,0 +1,44 @@
+Gust Forecast
+=============
+
+The Gust Forecast is a list of feature ideas that would be nice to have.  Ideally, this list is prioritized. (Maybe this list should be moved to Pivotal Tracker)
+
+### Allow for more than one Spreadsheet
+Currently the script overwrites all but the last spreadsheet
+
+### Refactor the Script class to be OO
+
+### Object groups accessible by title name
+
+For Example:
+
++ basic_objects.vehicles
++ basic_objects.fruits
++ basic_objects.cities
++ basic_object.vehicles.first.color
+
+### Title Row, Header Row, and Object Row are configurable
+
+```ruby
+Gust.load(spreadsheet_filepath, config_hash)
+Gust.config do |gust|
+  gust.title_row = 5
+  gust.object_row = 6
+end
+```
+
+### Objects are associable via sql-like foreign key attributes
+
+### Rails Plugin
+
+### Builds/Saves objects into Rails Models
+
+### Compatibility with more filetypes (using roo)
+
+### Formula Handling
+
++ Get true/false values
++ Formula specific methods/accessors
+
+### Multiple Tables Vertically stacked in One Spreadsheet
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    rb-gust (0.0.1)
+      active_support
+      spreadsheet
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    method_source (0.8.1)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    ruby-ole (1.2.11.6)
+    slop (3.4.5)
+    spreadsheet (0.8.5)
+      ruby-ole (>= 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rb-gust!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jfeaver
+
+MIT License
+
+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,54 @@
+# Gust
+
+Gust allows you to load many objects from an excel spreadsheet (.xls only) into Ruby objects.
+
+```ruby
+objects = Gust.load('/path/to/spreadsheet.xls')
+```
+
+... and you're off!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rb-gust'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rb-gust
+
+## Usage
+
+Format a Spreadsheet (see the example spreadsheet [here](spec/workbooks/basic_objects.xls)):
+
++ first row with content as the object titles.
++ second row has column headers
++ third row begins the object data values
+
+To load the objects into Ruby, use Gust.load(). An RSpec example:
+
+```ruby
+objects = Gust.load('/gust_gem_path/spec/worksheets/basic_objects.xls')
+objects[:vehicles].should eq(
+  [
+    {:name=>"sedan", :wheels=>4.0, :color=>"blue"},
+    {:name=>"sports car", :wheels=>4.0, :color=>"red"},
+    {:name=>"moving truck", :wheels=>6.0, :color=>"white"},
+  ]
+)
+```
+
+## Contributing
+
+Check out the [feature forecast](FORECAST.md) for desired features.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rb-gust/script.rb

@@ -0,0 +1,45 @@
+module Gust
+  class Script
+    attr_reader :objects, :object_groups
+
+    require 'active_support/inflector'
+    def build_object_groups
+      @object_groups = {}
+      @titles.each_with_index do |title,i|
+        group_name = ActiveSupport::Inflector.tableize(title).to_sym
+        @object_groups[group_name] = group_objects(@headers[i], @objects[i])
+      end
+    end
+
+    def group_objects headers, object_data
+      group = []
+      object_data.each do |object_attributes|
+        next if object_attributes.compact.empty?
+        group << hashify_object(headers, object_attributes)
+      end
+      group
+    end
+
+    def hashify_object(headers, object_attributes)
+      hash = {}
+      headers.each_with_index do |header, i|
+        hash[header.to_sym] = object_attributes[i]
+      end
+      hash
+    end
+
+    def script
+      _wb = ::Spreadsheet.open(Gust.workbook_filepath)
+
+      _wb.worksheets.each do |_ws|
+        @ws = Gust::Spreadsheet::Worksheet.new(_ws)
+        @titles = @ws.titles
+        @headers = @ws.headers
+        @objects = @ws.objects
+        build_object_groups
+      end
+
+      @object_groups
+    end
+  end
+end

data/lib/rb-gust/spreadsheet/structure.rb

@@ -0,0 +1,50 @@
+module Gust::Spreadsheet
+  class Structure
+    attr_reader :header_row, :object_regions, :inside
+
+    def initialize header_row
+      @header_row = header_row
+      @object_regions = []
+      determine_object_structure
+    end
+
+    private
+
+    def determine_object_structure
+      @inside = false
+      start_index = 0
+      header_row.each_with_index do |cell, i|
+        if single_column_object?(i)
+          @object_regions << [i,i]
+        elsif first_column?(cell)
+          start_index = i
+          @inside = true
+        elsif last_column?(i)
+          @object_regions << [start_index, i]
+          @inside = false
+        end
+      end
+    end
+
+    def single_column_object? i
+      not(inside) && last_object_heading?(i)
+    end
+
+    def first_column?(cell)
+      not(inside) && present?(cell)
+    end
+
+    def last_column?(i)
+      inside && last_object_heading?(i)
+    end
+
+    def present? cell
+      cell && cell.length > 0
+    end
+
+    def last_object_heading? i
+      present?(header_row[i]) && not(present?(header_row[i+1]))
+    end
+
+  end
+end

data/lib/rb-gust/spreadsheet/worksheet.rb

@@ -0,0 +1,62 @@
+module Gust::Spreadsheet
+  class Worksheet
+    attr_reader :worksheet
+    attr_reader :title_row_index, :header_row_index, :object_row_index
+    attr_reader :object_regions
+    attr_reader :titles, :headers, :objects
+
+    def initialize worksheet
+      @worksheet = worksheet
+      @title_row_index = @worksheet.dimensions.first
+      @header_row_index = @title_row_index + 1
+      @object_row_index = @title_row_index + 2
+      @object_regions = Gust::Spreadsheet::Structure.new(header_row).object_regions
+      @titles = []
+      @headers = []
+      define_object_titles(title_row)
+      define_headers(header_row)
+      define_objects(object_rows)
+    end
+
+    def title_row
+      @worksheet.row(title_row_index)
+    end
+
+    def header_row
+      @worksheet.row(header_row_index)
+    end
+
+    def object_rows
+      rows = []
+      @worksheet.each(object_row_index) do |row|
+        rows << row
+      end
+      rows
+    end
+
+    def define_object_titles title_row
+      object_regions.each do |r|
+        @titles << title_row[r.first]
+      end
+    end
+
+    def define_headers header_row
+      object_regions.each do |r|
+        object_headers = header_row[r[0]..r[1]]
+        @headers << object_headers
+      end
+    end
+
+    def define_objects object_rows
+      @objects = []
+      object_rows.each do |object_row|
+        object_regions.each_with_index do |r,i|
+          @objects << []
+          object = object_row[r[0]..r[1]]
+          @objects[i] << object
+        end
+      end
+    end
+
+  end
+end

data/lib/rb-gust/spreadsheet.rb

@@ -0,0 +1,6 @@
+require 'rb-gust/spreadsheet/worksheet'
+require 'rb-gust/spreadsheet/structure'
+
+module Gust::Spreadsheet
+end
+

data/lib/rb-gust/version.rb

@@ -0,0 +1,3 @@
+module Gust
+  VERSION = "0.0.1"
+end

data/lib/rb-gust.rb

@@ -0,0 +1,19 @@
+
+require 'spreadsheet'
+
+require 'rb-gust/version'
+require 'rb-gust/script'
+require 'rb-gust/spreadsheet'
+
+module Gust
+
+  def self.workbook_filepath
+    @@workbook_filepath
+  end
+
+  def self.load workbook_filepath
+    @@workbook_filepath = workbook_filepath
+    Script.new.script
+  end
+
+end

data/rb-gust.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rb-gust/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rb-gust"
+  gem.description   = 'A tool for loading spreadsheet data into ruby objects'
+  gem.summary       = 'Load data from a spreadsheets directly into Ruby objects for further manipulation. Useful while bulk uploading data for applications, analytics, or scripting.'
+  gem.homepage      = 'http://www.github.com/jfeaver/rb-gust/'
+
+  gem.version       = Gust::VERSION
+  gem.license       = 'MIT'
+
+  gem.authors       = 'Nathan Feaver'
+  gem.email         = 'nathan@nathanfeaver.com'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  ### DEPENDENCIES
+  gem.add_dependency('spreadsheet')
+  gem.add_dependency('active_support')
+
+  # Development Dependencies
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('pry')
+end

data/spec/gust_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Gust do
+  before do
+    @path = File.join(File.dirname(__FILE__), 'workbooks','basic_objects.xls')
+  end
+
+  it "is already loaded" do
+    require('rb-gust').should be_false
+  end
+
+  it "should have objects" do
+    o = Gust.load(@path)
+    o.should be_a(Hash)
+  end
+
+  it "should not contain any empty objects" do
+    o = Gust.load(@path)
+    o.each do |object_title, object_group|
+      object_group.none? do |object|
+        object.values.compact.empty?
+      end.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+
+## Development Dependencies
+require 'pry'
+
+## Load Gust
+require 'rb-gust'
+
+## Sample Application
+#APP_ROOT = File.join(File.dirname(__FILE__), 'app')
+
+## Configure RSpec
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+## Spec Helpers
+#Dir[File.join(File.dirname(__FILE__), 'helpers', '**', '*_helper.rb')].each do |f|
+#  require f
+#end
+

data/spec/spreadsheet/structure_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Gust::Spreadsheet::Structure do
+
+  it "knows the object regions" do
+    # Gust assumes that you have spacers between separate object headers
+    header_row = [nil, 'headerA1', 'headerA2', nil, nil, 'headerB1', 'headerB2', 'headerB3', nil, 'headerC1']
+    @structure = Gust::Spreadsheet::Structure.new(header_row)
+    @structure.object_regions.should == [[1,2],[5,7],[9,9]]
+  end
+
+end
+

data/spec/spreadsheet/worksheet_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Gust::Spreadsheet::Worksheet do
+  before :each do
+    path = File.join(File.expand_path('..', File.dirname(__FILE__)), 'workbooks','basic_objects.xls')
+    _s = Spreadsheet.open(path)
+    _ws = _s.worksheet('basic_objects')
+    @ws = Gust::Spreadsheet::Worksheet.new(_ws)
+  end
+
+  it "handles all interactions with the Spreadsheet gem Worksheets" do
+    @ws.worksheet.should be_a(::Spreadsheet::Excel::Worksheet)
+  end
+
+  it "knows about the title row" do
+    @ws.title_row.should include('Vehicles')
+  end
+
+  it "knows about the header row" do
+    @ws.header_row.should include('juicable?')
+  end
+
+  it "knows about the object rows" do
+    @ws.object_rows.should have(4).object_rows
+  end
+
+  it "knows its own titles" do
+    titles = %w(Vehicles Fruits Cities)
+    @ws.titles.should eq(titles)
+  end
+
+  it "knows the object headers" do
+    headers = [%w(name wheels color),%w(id type juicable?),%w(name state).push('favorite fruit id')]
+    @ws.headers.should eq(headers)
+  end
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rb-gust
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Feaver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  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'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A tool for loading spreadsheet data into ruby objects
+email: nathan@nathanfeaver.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- FORECAST.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rb-gust.rb
+- lib/rb-gust/script.rb
+- lib/rb-gust/spreadsheet.rb
+- lib/rb-gust/spreadsheet/structure.rb
+- lib/rb-gust/spreadsheet/worksheet.rb
+- lib/rb-gust/version.rb
+- rb-gust.gemspec
+- spec/gust_spec.rb
+- spec/spec_helper.rb
+- spec/spreadsheet/structure_spec.rb
+- spec/spreadsheet/worksheet_spec.rb
+- spec/workbooks/basic_objects.xls
+homepage: http://www.github.com/jfeaver/rb-gust/
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Load data from a spreadsheets directly into Ruby objects for further manipulation.
+  Useful while bulk uploading data for applications, analytics, or scripting.
+test_files:
+- spec/gust_spec.rb
+- spec/spec_helper.rb
+- spec/spreadsheet/structure_spec.rb
+- spec/spreadsheet/worksheet_spec.rb
+- spec/workbooks/basic_objects.xls