scottburton11-tokyomapper 0.1.0 → 0.1.1

data/.gitignore

@@ -3,3 +3,4 @@
 coverage
 rdoc
 pkg
+*.tdb

data/README.rdoc

@@ -1,27 +1,29 @@
 = tokyomapper
 
-TokyoMapper is an extremely lightweight ORM for TokyoCabinet. It stuffs your instance variables into a .tdb row, and loads them into new instances on #find. Nothing fancy!
+TokyoMapper is an extremely lightweight ORM for TokyoCabinet. 
+
+It stuffs your instance variables into a .tdb row, and loads them into new instances on #find. Nothing fancy!
 
 == Example
 
 
-class Elephant
-  include TokyoMapper
+  class Elephant
+    include TokyoMapper
   
-  attr_accessor :trunk_length
+    attr_accessor :trunk_length
   
-  def initialize(params)
-    @trunk_length = params[:trunk_length]
-  end  
-end
+    def initialize(params)
+      @trunk_length = params[:trunk_length]
+    end  
+  end
 
-elephant = Elephant.new(:trunk_length => "Super Long")
-elephant.save
-#=> true
-# creates elephant.tdb unless it exists
+  elephant = Elephant.new(:trunk_length => "Super Long")
+  elephant.save
+  #=> true
+  # creates elephant.tdb unless it exists
 
-Elephant.all
-#=> [#<Elephant:0x18b8100 @trunk_length="Super Long"]
+  Elephant.all
+  #=> [#<Elephant:0x18b8100 @trunk_length="Super Long"]
 
 
 
@@ -32,8 +34,6 @@ Elephant.all
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/features/env/env.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'tokyomapper'
+
+require 'spec/expectations'
+require 'features/env/feature_helpers'
+
+Before do
+  
+end
+
+
+After do
+  clean_up_databases
+end

data/features/env/feature_helpers.rb

@@ -0,0 +1,8 @@
+module FeatureHelpers
+  def clean_up_databases
+    # Dir.glob("#{__FILE__}/../../*.tdb").each {|file| File.delete(file)}
+    Dir.glob("./*.tdb").each {|file| File.delete(file)}
+  end
+end
+
+World(FeatureHelpers)

data/features/save_row.feature

@@ -0,0 +1,13 @@
+Feature: Save a row to the database
+  In order to persist an instance of my class
+  As a user
+  I want to call #save on my class name
+  
+  Background:
+    Given I have included TokyoMapper in my class
+    
+  Scenario: Call #save
+    Given I have an instance of my class with some data
+    When I call save on it
+    Then it should get saved to the database
+  

data/features/step_definitions/tokyo_mapper_steps.rb

@@ -0,0 +1,25 @@
+Given /^I have included TokyoMapper in my class$/ do
+  
+  class MyClass
+    include TokyoMapper
+    attr_accessor :attr1
+    attr_accessor :attr2
+    def initialize(attrs)
+      @attr1 = attrs[:attr1]
+      @attr2 = attrs[:attr2]
+    end
+  end
+  
+end
+
+Given /^I have an instance of my class with some data$/ do
+  @my_instance = MyClass.new(:attr1 => "Data1", :attr2 => "Data2")
+end
+
+When /^I call save on it$/ do
+  @my_instance.save
+end
+
+Then /^it should get saved to the database$/ do
+  MyClass.all.size.should be(1)
+end

data/lib/tokyomapper.rb

@@ -1,3 +1,5 @@
+require 'tokyocabinet'
+
 module TokyoMapper
   include TokyoCabinet
   
@@ -62,7 +64,17 @@ module TokyoMapper
   module InstanceMethods
         
     def save
-      self.class.connection { |db| db.put(db.genuid, self.class.stringify_keys(self.instance_values))}
+      self.class.connection do |db| 
+        db.put(db.genuid, self.class.stringify_keys(self.instance_values))
+      end
+    end
+    
+    def instance_values
+      instance_values_hash = Hash.new
+      instance_variables.each do |key|
+        instance_values_hash[key.instance_variable_name] = self.send(key.instance_variable_name.to_sym)
+      end
+      return instance_values_hash
     end
     
   end
@@ -72,4 +84,37 @@ module TokyoMapper
     receiver.send :include, InstanceMethods
   end
   
+end
+
+class String
+  def pluralize
+    case self
+    when %r|s$|
+      self << "es"
+    when %r|sh$|
+      self << "es"
+    when %r|e$|
+      self << "s"
+    when %r|o$|
+      self << "es"
+    when %r|[aeiou]+y$|
+      self << "s"
+    when %r|[^aeiou]+y$|
+      self.chomp("y") << "ies"
+    else
+      self << "s"
+    end
+  end
+  
+  def instance_variable_name
+    case self
+    when %r|^:@|
+      self.delete(":@")
+    when %r|^@|
+      self.delete("@")
+    else
+      self
+    end
+  end
+  
 end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tokyomapper'
+require 'spec'
+require 'spec/autorun'
+
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/string_extensions_spec.rb

@@ -0,0 +1,59 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+describe String, "pluralization" do
+  
+  it "should add an 's' at the end of strings ending in 'e'" do
+    string = "Quiche"
+    string.pluralize.should eql("Quiches")
+  end
+  
+  it "should add an 'es' to the end of strings ending in 'o'" do
+    string = "Hero"
+    string.pluralize.should eql("Heroes")
+  end
+  
+  it "should add an 'ies' to the end of strings ending in a consonant and 'y'" do
+    string = "Cherry"
+    string.pluralize.should eql("Cherries")
+  end
+  
+  it "should add an 's' to the end of strings ending in a vowel and 'y'" do
+    string = "Day"
+    string.pluralize.should eql("Days")
+  end
+  
+  it "should add an 's' at the end of most strings ending in consonants" do
+    string = "Kitten"
+    string.pluralize.should eql("Kittens")
+  end
+  
+  it "should add an 'es' at the end of strings ending in 's'" do
+    string = "Kiss"
+    string.pluralize.should eql("Kisses")
+  end
+  
+  it "should add an 'es' to the end of strings with a sibilant 'sh'" do
+    string = "Dish"
+    string.pluralize.should eql("Dishes")
+  end
+  
+end
+
+describe String, "instance_variable_name method" do
+  
+  it "should remove the @ symbol" do
+    name = "@bar"
+    name.instance_variable_name.should eql("bar")
+  end
+  
+  it "should remove any :@ symbol combination" do
+    name = ":@bar"
+    name.instance_variable_name.should eql("bar")    
+  end
+  
+  it "shouldn't affect strings with just a colon :" do
+    name = ":not_a_symbol"
+    name.instance_variable_name.should eql(name)
+  end
+  
+end

data/spec/tokyo_mapper_spec.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+module TestSetup
+  class TestClass
+    include TokyoMapper
+    attr_accessor :attr1
+    attr_accessor :attr2
+    def initialize(attrs = {:attr1 => "attribute 1 value", :attr2 => "attribute 2 value"})
+      @attr1 = attrs[:attr1]
+      @attr2 = attrs[:attr2]
+    end
+  end
+end
+
+describe TokyoMapper::InstanceMethods, "instance_values method" do
+  include TestSetup
+  
+  before(:each) do
+    @test = TestSetup::TestClass.new
+  end
+
+  it "returns a hash of instance variable names and their values" do
+    @test.instance_values.should == {"attr1" => "attribute 1 value", "attr2" => "attribute 2 value"}
+  end
+end
+
+
+describe TokyoMapper, "save a record" do
+  include TestSetup
+  
+  before(:each) do
+    @test = TestSetup::TestClass.new(:attr1 => "Test 1", :attr2 => "Test 2")
+    TestSetup::TestClass.db.stub!(:open).and_return(true)
+    TestSetup::TestClass.db.stub!(:close).and_return(true)
+    TestSetup::TestClass.db.stub!(:genuid).and_return("1")
+    TestSetup::TestClass.db.should_receive(:put).with("1", {"attr1" => "Test 1", "attr2" => "Test 2"}).and_return(true)
+  end
+  
+  it "should be true" do
+    @test.save.should be(true)
+  end
+end

data/tokyomapper.gemspec

@@ -0,0 +1,58 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tokyomapper}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Burton"]
+  s.date = %q{2009-08-17}
+  s.description = %q{TokyoMapper is a simple ORM for TokyoCabinet. Just 'include TokyoMapper' in your class and go! Requires the tokyocabinet-ruby bindings and the tokyocabinet package.}
+  s.email = %q{scottburton11@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "features/env/env.rb",
+     "features/env/feature_helpers.rb",
+     "features/save_row.feature",
+     "features/step_definitions/tokyo_mapper_steps.rb",
+     "lib/tokyomapper.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/string_extensions_spec.rb",
+     "spec/tokyo_mapper_spec.rb",
+     "test/test_helper.rb",
+     "test/tokyomapper_test.rb",
+     "tokyomapper.gemspec"
+  ]
+  s.homepage = %q{http://github.com/scottburton11/tokyomapper}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A succinct ORM for TokyoCabinet}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/string_extensions_spec.rb",
+     "spec/tokyo_mapper_spec.rb",
+     "test/test_helper.rb",
+     "test/tokyomapper_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scottburton11-tokyomapper
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Scott Burton
@@ -29,9 +29,18 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- features/env/env.rb
+- features/env/feature_helpers.rb
+- features/save_row.feature
+- features/step_definitions/tokyo_mapper_steps.rb
 - lib/tokyomapper.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/string_extensions_spec.rb
+- spec/tokyo_mapper_spec.rb
 - test/test_helper.rb
 - test/tokyomapper_test.rb
+- tokyomapper.gemspec
 has_rdoc: false
 homepage: http://github.com/scottburton11/tokyomapper
 licenses: 
@@ -60,5 +69,8 @@ signing_key:
 specification_version: 3
 summary: A succinct ORM for TokyoCabinet
 test_files: 
+- spec/spec_helper.rb
+- spec/string_extensions_spec.rb
+- spec/tokyo_mapper_spec.rb
 - test/test_helper.rb
 - test/tokyomapper_test.rb