sheet_mapper 0.0.1 → 0.1.0

data/.travis.yml

@@ -0,0 +1,10 @@
+# http://about.travis-ci.org/docs/user/build-configuration/
+before_script: "git submodule update --init"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx
+notifications:
+  recipients:
+    - nesquena@gmail.com

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Nathan Esquenazi
+
+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

@@ -16,7 +16,7 @@ and then `require 'sheet_mapper'` and you are done!
 
 ## Usage
 
-First, define yourself an object mapper:
+First, you describe how to map a spreadsheet into data rows with a sheet object mapper:
 
 ```ruby
 class SomeMapper < SheetMapper::Base
@@ -36,20 +36,65 @@ class SomeMapper < SheetMapper::Base
 end
 ```
 
-This describes the column mappings and transformations to turn a spreadsheet row into a ruby object. Then you can use
-a mapper within a worksheet collection:
+The mapper describes the column mappings and transformations to turn a spreadsheet row into a ruby object. Then you can apply
+a mapper to any worksheet (collection):
 
 ```ruby
-sheet = SheetMapper::Worksheet.new(:mapper => SomeMapper, :key => 'k', :login => 'u', :password => 'p')
+# Login and access a particular spreadsheet by key
+sheet = SheetMapper::Spreadsheet.new(:mapper=>SomeMapper, :key=>'k', :login => 'u', :password => 'p')
+# Find a particular worksheet (collection) by title
 collection = sheet.find_collection_by_title('title')
+# Iterate over the records within the worksheet
 records = collection.each do |record|
   p record.attributes
   # => { :foo => "...", :bar => false, ... }
 end
 ```
 
-You can then work with the objects within the collection and access their attributes.
+You can then work with objects within the collection and access their attributes. You can also modify objects and
+persist the changes back to the collection (worksheet):
+
+```ruby
+# Fetch the second data row from the spreadsheet
+record = collection.records[1]
+record[:foo] = "other"
+# Persist change of value to worksheet
+collection.save
+# or more explicitly collection.save(record)
+```
+
+If you want to reset changes made to your records, just use the reload method:
+
+```ruby
+# Fetch the second data row from the spreadsheet
+record = collection.records[1]
+record[:foo] = "other"
+# Reset unsaved changes
+collection.reload
+```
+
+You may also come across situations where you need access to 'meta' information associated with the collection.
+Use the 'cell' method to access arbitrary data points:
+
+```ruby
+# Accesses row 1, column 2 within the worksheet
+collection.cell(1, 2) => "foo"
+```
 
 ## Contributors
 
-SheetMapper was created by [Nathan Esquenazi](http://github.com/nesquena) at Miso in 2012.
+SheetMapper was created by [Nathan Esquenazi](http://github.com/nesquena) at Miso in 2012.
+
+## Tasks
+
+SheetMapper is a new gem and I would love any feedback and/or pull requests.
+
+## Continuous Integration ##
+
+[![Continuous Integration status](https://secure.travis-ci.org/nesquena/sheet_mapper.png)](http://travis-ci.org/nesquena/sheet_mapper)
+
+CI is hosted by [travis-ci.org](http://travis-ci.org).
+
+## License
+
+Check `LICENSE` but of course feel free to use this in any projects.

data/Rakefile

@@ -5,4 +5,7 @@ Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/*_test.rb'
   test.ruby_opts = ['-rubygems']
-end
+end
+
+desc "Run tests for rabl"
+task :default => :test

data/example.rb

@@ -1,53 +1,36 @@
-=begin
-
- class BubbleMapper < SheetMapper::Base
-   attributes :offset_seconds, :body, :link_url, :category
- end
-
- sheet = SheetMapper::Worksheet.new(:mapper => BubbleMapper, :key => 'sheet_key', :login => 'user', :password => 'pass')
- collection = sheet.find_collection_by_title('title')
- bubbles = collection.each do |bubble|
-   p bubble.to_hash
- end
-
-=end
-
 require 'rubygems'
 require 'active_support/all'
 require 'google_spreadsheet'
 require File.expand_path('lib/sheet_mapper')
 
-class BubbleMapper < SheetMapper::Base
-  columns :offset_seconds, :is_notable, :category, :body, :image_url, :link_text, :link_url
+class GradeMapper < SheetMapper::Base
+  columns :topic, :grade, :score
 
   def valid_row?
-    self[:body].present? && @pos > 7
-  end
-
-  def offset_seconds
-    return unless self[:offset_seconds].strip =~ /^[\d\:]+$/ # Only return offset if valid digits
-    offset = self[:offset_seconds].strip.split(':')
-    (offset[0].to_i * 60) + offset[1].to_i
+    self[:topic].present? && @pos > 4
   end
 
   # Convert is_notable to boolean
-  def is_notable
-    self[:is_notable].to_s.match(/true/i).present?
+  def score
+    self[:score].to_i
   end
 end
 
-sheet = SheetMapper::Spreadsheet.new(:mapper => BubbleMapper, :key => ENV['SHEET_KEY'], :login => ENV['SHEET_LOGIN'], :password => ENV['SHEET_PASS'])
-collection = sheet.find_collection_by_title('s2e5')
+sheet = SheetMapper::Spreadsheet.new(:mapper => GradeMapper, :key => ENV['SHEET_KEY'], :login => ENV['SHEET_LOGIN'], :password => ENV['SHEET_PASS'])
+collection = sheet.find_collection_by_title('data')
 
-media_id        = collection.cell(2, 2)
-season_num      = collection.cell(3, 2)
-episode_num     = collection.cell(4, 2)
-user_id         = collection.cell(5, 2)
-duration        = collection.cell(6, 2)
+name        = collection.cell(1, 2)
+age         = collection.cell(2, 2)
 
-puts "Media: #{media_id}, User: #{user_id}"
+puts "Name: #{name}, Age: #{age}"
 
 bubbles = collection.each do |bubble|
-  p bubble.attributes
+  p bubble.attributes # => { :topic => "...", :grade => "...", :score => "..." }
 end
 
+b = collection.records[1]
+b[:grade] = "B"
+b[:score] = 86
+
+collection.save
+

data/lib/sheet_mapper/base.rb

@@ -1,7 +1,9 @@
 module SheetMapper
   class Base
 
-    # SheetMapper::Base.new(0, ["foo", "bar"])
+    attr_reader :pos
+
+    # SheetMapper::Base.new(1, ["foo", "bar"])
     def initialize(pos, data=[])
       @pos    = pos
       @data   = data
@@ -39,6 +41,18 @@ module SheetMapper
       true
     end
 
+    # Returns an array of data values based on the order of the spreadsheet
+    # @record.to_a => ["Foo", "Bar", 15]
+    def attribute_values
+      self.column_order.inject([]) { |res, name| res << @attrs[name]; res }
+    end
+
+    # Returns true if a record has been modified from original state
+    # @record.changed? => true
+    def changed?
+      @data != self.attribute_values
+    end
+
     protected
 
     # column_order => [:offset_seconds, :body, :link_url, :category]
@@ -60,16 +74,15 @@ module SheetMapper
     # Process all columns into an attribute hash
     def process_data
       m = HashWithIndifferentAccess.new
-      column_order.each { |name| m[name.to_s] = self.attribute_value(name) }
+      column_order.each { |name| m[name.to_s] = self.fetch_data_value(name) }
       m
     end
 
-    # attribute_value(:body, 1, 1) => "Foo"
-    # attribute_value(:image_url, 1, 3) => nil
-    # attribute_value(:link_text, 2) => "Article"
-    # Create a method "format_<name>" to transform the column value (or pass the value directly)
-    # Column position defaults to matching named column in `column_order`
-    def attribute_value(name)
+    # fetch_data_value(:body) => "Foo"
+    # fetch_data_value(:image_url) => nil
+    # fetch_data_value(:link_text) => "Article"
+    # Column position is found by matching named column in `column_order`
+    def fetch_data_value(name)
       val = @data[column_pos(name)]
       val = val.to_i if val && name.to_s =~ /_(id|num)/
       val

data/lib/sheet_mapper/collection.rb

@@ -31,6 +31,20 @@ module SheetMapper
       @worksheet[row, col]
     end
 
+    # Saves the records that have changed back to spreadsheet
+    # @collection.save
+    # @collection.save(@record)
+    def save(records=@records)
+      Array(records).each { |r| @worksheet.update_cells(r.pos, 1, [r.attribute_values]) if r.changed? }
+      @worksheet.save
+    end
+
+    # Reload worksheet discarding changes not saved
+    def reload
+      @worksheet.reload
+      @records = process_records!
+    end
+
     protected
 
     # Converts all valid raw data hashes into mapped records
@@ -38,7 +52,7 @@ module SheetMapper
     def process_records!
       records = []
       @worksheet.rows.each_with_index do |record, index|
-        record = @mapper.new(index, record)
+        record = @mapper.new(index + 1, record)
         records << record if record.valid_row?
       end
       records

data/lib/sheet_mapper/version.rb

@@ -1,3 +1,3 @@
 module SheetMapper
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/base_test.rb

@@ -17,10 +17,15 @@ describe "Base" do
     @data = ["Bob", 21, "Red"]
   end
 
-  should "support columns accessor" do
+  should "support columns class accessor" do
     assert_equal [:name, :age, :color], TestBase.columns
   end
 
+  should "support pos instances accessor" do
+    @test = TestBase.new(1, @data)
+    assert_equal 1, @test.pos
+  end
+
   context "for attributes method" do
     setup do
       @test = TestBase.new(1, @data)
@@ -53,4 +58,31 @@ describe "Base" do
       assert_equal 45, @test[:age]
     end
   end # assign []=
+
+  context "for attribute_values method" do
+    setup do
+      @test = TestBase.new(1, @data)
+      @test[:age] = 45
+    end
+
+    should "return attribute values in proper order as list" do
+      assert_equal ["Bob", 45, "Red"], @test.attribute_values
+    end
+  end # attribute_values
+
+  context "for changed? method" do
+    setup do
+      @test = TestBase.new(1, @data)
+    end
+
+    should "return false if not changed" do
+      @test[:age] = 21
+      assert_equal false, @test.changed?
+    end
+
+    should "return true if changed" do
+      @test[:age] = 45
+      assert_equal true, @test.changed?
+    end
+  end # attribute_values
 end # Base

data/test/collection_test.rb

@@ -12,6 +12,9 @@ class TestMapper
   def name; record[:name]; end
   def age;  record[:age]; end
   def valid_row?; true; end
+  def pos; 3; end
+  def attribute_values; tuple; end
+  def changed?; true; end
 end # TestMapper
 
 describe "Collection" do
@@ -82,4 +85,35 @@ describe "Collection" do
       assert_equal ["Joey", 67], rows[2].tuple
     end
   end # records
+
+  context "for save method" do
+    setup do
+      @collection = SheetMapper::Collection.new(@spreadsheet, @worksheet)
+      @rows = @collection.records
+    end
+
+    should "persist back to worksheet all rows" do
+      @rows.each { |r| @worksheet.expects(:update_cells).with(r.pos, 1, [r.attribute_values]) }
+      @worksheet.expects(:save).once
+      @collection.save
+    end
+
+    should "persist back to worksheet one row" do
+      first_row = @collection.records.first
+      @worksheet.expects(:update_cells).with(first_row.pos, 1, [first_row.attribute_values])
+      @worksheet.expects(:save).once
+      @collection.save(first_row)
+    end
+  end # save
+
+  context "for reload method" do
+    setup do
+      @collection = SheetMapper::Collection.new(@spreadsheet, @worksheet)
+    end
+
+    should "persist back to worksheet" do
+      @worksheet.expects(:reload).once
+      @collection.reload
+    end
+  end # reload
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sheet_mapper
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-15 00:00:00 -07:00
-default_executable: 
+date: 2012-05-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: google-spreadsheet-ruby
@@ -117,11 +116,12 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - example.rb
-- example2.rb
 - lib/core_ext/hash_ext.rb
 - lib/core_ext/object_ext.rb
 - lib/sheet_mapper.rb
@@ -135,7 +135,6 @@ files:
 - test/spreadsheet_test.rb
 - test/test_config.rb
 - test/test_helpers/mini_shoulda.rb
-has_rdoc: true
 homepage: ""
 licenses: []
 
@@ -165,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: sheet_mapper
-rubygems_version: 1.6.2
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Map google spreadsheets to ruby objects

data/example2.rb

@@ -1,30 +0,0 @@
-require 'rubygems'
-require 'active_support/all'
-require 'google_spreadsheet'
-require File.expand_path('lib/sheet_mapper')
-
-class GradeMapper < SheetMapper::Base
-  columns :topic, :grade, :score
-
-  def valid_row?
-    self[:topic].present? && @pos > 3
-  end
-
-  # Convert is_notable to boolean
-  def score
-    self[:score].to_i
-  end
-end
-
-sheet = SheetMapper::Spreadsheet.new(:mapper => GradeMapper, :key => ENV['SHEET_KEY'], :login => ENV['SHEET_LOGIN'], :password => ENV['SHEET_PASS'])
-collection = sheet.find_collection_by_title('data')
-
-name        = collection.cell(1, 2)
-age         = collection.cell(2, 2)
-
-puts "Name: #{name}, Age: #{age}"
-
-bubbles = collection.each do |bubble|
-  p bubble.attributes
-end
-