sheet_mapper 0.1.0 → 0.1.1

data/README.md

@@ -1,6 +1,6 @@
 # SheetMapper
 
-SheetMapper is about taking a google spreadsheet and converting a set of data rows into ruby objects.
+SheetMapper is about taking a google spreadsheet and converting a set of data rows into simple ruby objects.
 
 ## Installation
 
@@ -14,6 +14,13 @@ gem 'sheet_mapper'
 
 and then `require 'sheet_mapper'` and you are done!
 
+## Rationale
+
+You may ask why you would need to have an object mapper from a Google Spreadsheet. Consider though that spreadsheets are collaborative, have revision tracking, securely authenticated, are accessible anywhere and are familiar to non-technical people. 
+
+If you ever needed a dead simple admin interface, configuration document, or basic content management system, a spreadsheet is a pretty great solution that requires very little engineering overhead. Next time you are in a position where non-technical people
+need to manage data, ask yourself if a spreadsheet might be a good first solution.
+
 ## Usage
 
 First, you describe how to map a spreadsheet into data rows with a sheet object mapper:
@@ -21,16 +28,18 @@ First, you describe how to map a spreadsheet into data rows with a sheet object
 ```ruby
 class SomeMapper < SheetMapper::Base
   # Defines each column for a row and maps each column to an attribute
+  # Should be listed in the order the data appears in the spreadsheet
   columns :foo, :bar, :baz
 
   # Defines the condition for a row to be considered valid
+  # Also have access to `pos` which is the row number in the worksheet
   def valid_row?
-    self[:foo].present?
+    self[:foo].present? && self.pos > 2
   end
 
-  # Convert is_notable column to a boolean from raw string
-  # Any methods named after a column will override the default value
-  def is_notable
+  # Convert bar column to a boolean from raw string
+  # Any method named after a column will override the default value
+  def bar
     !!self[:bar].match(/true/i)
   end
 end
@@ -87,7 +96,15 @@ SheetMapper was created by [Nathan Esquenazi](http://github.com/nesquena) at Mis
 
 ## Tasks
 
-SheetMapper is a new gem and I would love any feedback and/or pull requests.
+SheetMapper is a new gem and I would love any feedback and/or pull requests. In particular:
+
+ * Inserting a data row into a collection
+ * Removing a data row from a collection
+ * Callbacks
+ * Validations
+ * Column Type Casting
+
+Please fork if you are inspired to add any of these or any other improvements.
 
 ## Continuous Integration ##
 

data/lib/sheet_mapper/base.rb

@@ -8,11 +8,13 @@ module SheetMapper
       @pos    = pos
       @data   = data
       @attrs  = process_data
+      self.class.create_accessors!(@attrs)
     end
 
     # columns :offset_seconds, :body, :link_url, :category
     def self.columns(*names)
-      names.any? ? @columns = names : @columns
+      @columns ||= []
+      names.any? ? @columns += names : @columns
     end
 
     # Returns the spreadsheet as a hash
@@ -55,6 +57,11 @@ module SheetMapper
 
     protected
 
+    # Allows subclasses to inherit class ivars for columns
+    def self.inherited(subclass)
+      subclass.instance_variable_set("@columns", @columns)
+    end
+
     # column_order => [:offset_seconds, :body, :link_url, :category]
     def column_order
       self.class.columns
@@ -88,5 +95,14 @@ module SheetMapper
       val
     end
 
+    # Creates getters and setters for all attributes
+    # Post.create_accessors!(:foo => 'bar', :baz => "foo")
+    def self.create_accessors!(attrs)
+      attrs.each do |name, value|
+        define_method(name) { self[name] } unless method_defined?(name)
+        define_method("#{name}=") { |val| self[name] = val } unless method_defined?("#{name}=")
+      end
+    end
+
   end
 end

data/lib/sheet_mapper/version.rb

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

data/test/base_test.rb

@@ -1,17 +1,24 @@
 require File.expand_path('../test_config.rb', __FILE__)
 
 class TestBase < SheetMapper::Base
-  columns :name, :age, :color
+  columns :name, :age
+  columns :color
 
   def age
     self[:age] * 2
   end
 
+  def age=(val)
+    self[:age] = val / 2
+  end
+
   def name
     self[:name].upcase
   end
 end
 
+class TestBaseExt < TestBase; end
+
 describe "Base" do
   setup do
     @data = ["Bob", 21, "Red"]
@@ -19,14 +26,14 @@ describe "Base" do
 
   should "support columns class accessor" do
     assert_equal [:name, :age, :color], TestBase.columns
-  end
+  end # columns
 
   should "support pos instances accessor" do
     @test = TestBase.new(1, @data)
     assert_equal 1, @test.pos
-  end
+  end # pos
 
-  context "for attributes method" do
+  context "for attribute methods" do
     setup do
       @test = TestBase.new(1, @data)
     end
@@ -34,10 +41,23 @@ describe "Base" do
     should "return attribute hash" do
       assert_equal "BOB", @test.name
       assert_equal 42, @test.age
-      assert_equal "Red", @test[:color]
+      assert_equal "Red", @test.color
     end
   end # attributes
 
+  context "for assignment of attributes" do
+    setup do
+      @test = TestBase.new(1, @data)
+    end
+
+    should "allow assignments" do
+      @test.age   = 46
+      @test.color = "Black"
+      assert_equal 23, @test[:age]
+      assert_equal "Black", @test[:color]
+    end
+  end
+
   context "for accessing attribute" do
     setup do
       @test = TestBase.new(1, @data)
@@ -59,6 +79,28 @@ describe "Base" do
     end
   end # assign []=
 
+  context "for color attribute accessor" do
+    setup do
+      @test = TestBase.new(1, @data)
+      @test_ext = TestBaseExt.new(1, @data)
+    end
+
+    should "support color auto accessor" do
+      assert_equal "Red", @test.color
+      assert_equal "Red", @test_ext.color
+    end
+
+    should "support color auto assigner" do
+      @test.color = "Blue"
+      assert_equal "Blue", @test.color
+    end
+
+    should "respond to color auto accessor" do
+      assert_respond_to @test, :color
+      assert_respond_to @test_ext, :color
+    end
+  end
+
   context "for attribute_values method" do
     setup do
       @test = TestBase.new(1, @data)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sheet_mapper
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-20 00:00:00 Z
+date: 2012-05-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: google-spreadsheet-ruby