plyushkin 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3ffa197a5ec8d8b23b72ba77444540524c17062
+  data.tar.gz: cfd45839d46278a89f81904eee6cc4cedb490b97
+SHA512:
+  metadata.gz: 20a5449a85d1753e8a08ec0bac1063827a1ddc3d1325edfd57d805072f9f90d4cf6bf581e2da6a51457daaf7c493543e750e9652b08e62b1f4dd1782b575ae8a
+  data.tar.gz: 0e26387d0792ec1ec44f78d8f5e1e738dd1f7c51cc1163305087dc76d52b0d6a67be1f84ad8674828452d2fcbcacb281ddebe85c113d29e0d3edcda897e9c28a

data/README.md

@@ -18,7 +18,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Configure the backend service that plyushkin will use in your environments/<environment>.rb file.  
+For example, to configure the stub service for running specs, the following code would go in your 
+config/environments/test.rb file of a Rails application.
+
+    config.before_initialize do |c|
+      Plyushkin::Service.service = Plyushkin::Service::Stub.new
+    end
+
+To use plyushkin against a live web service,
+assign an instance of ``Plyushkin::Service::Web.new(:url => 'http://yourservice.com')``
+
+## Testing
+
+Plyushkin provides RSpec matchers for testing class macros.  To use these matchers, 
+add ``config.include Plyushkin::Test::Matchers`` to your RSpec.configure in spec_helper.
+
+To test Plyushkin configuration in your model:
+
+    describe YourModel do
+      it { should persist_attribute(:your_attribute) }
+      it { should_not persist_attribute(:your_non_plyushkin_attribute) }
+      it { should persist_attribute(:your_attribute).with_format(:to_date) }
+      it { should_not persist_attribute(:your_attribute).with_format(:not_a_formatter) }
+    end
 
 ## Contributing
 

data/lib/plyushkin.rb

@@ -3,6 +3,7 @@ require "active_record"
 
 module Plyushkin; end
 path = File.dirname(File.expand_path(__FILE__)) 
+require path + "/plyushkin/error.rb"
 require path + "/plyushkin/base_value"
 require path + "/plyushkin/string_value"
 require path + "/plyushkin/nil_value"

data/lib/plyushkin/base_value.rb

@@ -9,12 +9,19 @@ class Plyushkin::BaseValue
     end
   end
 
+  def formatters
+    @formatters.dup
+  end
+
   def self.persisted_attr(*attributes)
     opts = attributes.last.is_a?(Hash) ? attributes.pop : {}
     names = attributes
     formatter = opts[:formatter]
 
+    names.each{|name| formatters[name] = formatter}
+
     persisted_attributes.concat(names)
+
     attr_writer *names
     names.each do |name|
       define_method(name) do
@@ -29,16 +36,24 @@ class Plyushkin::BaseValue
   end
 
   def self.persisted_attributes
-    if self.superclass == Object
+    if self.superclass == Object && self.superclass.class == Class
       @persisted_attributes ||= []
     else
       @persisted_attributes ||= superclass.persisted_attributes.dup
     end
   end
 
+  def self.formatters
+    if self.superclass == Object
+      @formatters ||= {}
+    else
+      @formatters ||= superclass.formatters.dup
+    end
+  end
+
  persisted_attr :date, :formatter => :to_date
   validates_each :date do |record, attr_name, value|
-    record.errors.add(attr_name, "cannot be in the future") unless value < DateTime.now
+    record.errors.add(attr_name, "cannot be in the future") unless value <= Time.now
   end
 
   def equal_value?(other)
@@ -49,11 +64,28 @@ class Plyushkin::BaseValue
   end
 
   def to_i(value)
-    value.to_i
+    value =~ /\A\d+\Z/ ? value.to_i : value
+  end
+
+  #TODO: Maybe this can be nicer.
+  def to_f(value)
+    begin
+      Float(value)
+    rescue ArgumentError => e
+      value
+    rescue TypeError => e
+      value
+    end
   end
 
   def to_date(value)
     value.is_a?(String) ? DateTime.parse(value) : value
   end
 
+  def to_bool(value)
+    return true if value == "true"
+    return false if value == "false"
+    return value
+  end
+
 end

data/lib/plyushkin/core_ext/active_record_base.rb

@@ -7,7 +7,7 @@ ActiveRecord::Base.instance_eval do
     end
     validates name, :plyushkin => true
 
-    plyushkin_model.register(name, opts[:type], opts)
+    plyushkin_model.register(name, opts[:type] || Plyushkin::StringValue, opts)
     plyushkin_model.register_callback(name, :after_create, opts[:after_create]) if opts[:after_create]
   end
 

data/lib/plyushkin/error.rb

@@ -0,0 +1 @@
+class Plyushkin::Error < StandardError; end

data/lib/plyushkin/model.rb

@@ -2,6 +2,10 @@ class Plyushkin::Model
   attr_reader :service, :name, :cache
 
   def initialize(service, name, cache)
+    raise Plyushkin::Error.new <<-ERROR unless service
+    Service cannot be nil.  Set Plyushkin::Service.service to a service instance in an initializer.
+    ERROR
+
     @service                 = service
     @types                   = {}
     @ignore_unchanged_values = {}

data/lib/plyushkin/property.rb

@@ -80,4 +80,8 @@ class Plyushkin::Property
 
     value_hashes == {} ? [] : [value_hashes]
   end
+
+  def nil?
+    last.is_a?(Plyushkin::NilValue)
+  end
 end

data/lib/plyushkin/test.rb

@@ -1 +1,2 @@
 require File.dirname(File.expand_path(__FILE__)) + "/test/value_types.rb"
+require File.dirname(File.expand_path(__FILE__)) + "/test/matchers.rb"

data/lib/plyushkin/test/hoarded_attribute_matcher.rb

@@ -0,0 +1,98 @@
+module Plyushkin::Test
+  class HoardedAttributeMatcher < Plyushkin::Test::MatcherBase
+    def initialize(attribute)
+      @attribute = attribute
+    end
+
+    def of_type(type)
+      matchers << OfTypeMatcher.new(@attribute, type)
+      self
+    end
+
+    def and_ignore_unchanged_values
+      matchers << IgnoreUnchangedMatcher.new(@attribute)
+      self
+    end
+
+    def and_after_create_call(sym)
+      matchers << CallbackMatcher.new(@attribute, sym)
+      self
+    end
+
+    def matches?(subject)
+      unless subject.class.plyushkin_model.registered_types.keys.include?(@attribute)
+        @failure_message          = "Plyushkin: does not hoard attribute #{@attribute}"
+        @negative_failure_message = "Plyushkin: hoards attribute #{@attribute}"
+      end
+      super
+    end
+
+    class OfTypeMatcher
+      def initialize(attr_name, type)
+        @attr_name, @type = attr_name, type
+      end
+
+      def match(subject)
+        subject.class.plyushkin_model.registered_types[@attr_name] == @type
+      end
+
+      def failure_message
+        message(false)
+      end
+
+      def negative_failure_message
+        message(true)
+      end
+
+      private
+      def message(negate)
+        "Plyushkin: Hoarded attribute #{@attr_name} is #{negate ? "" : "not"} of type #{@type}"
+      end
+    end
+
+    class IgnoreUnchangedMatcher
+      def initialize(attr_name)
+        @attr_name = attr_name
+      end
+
+      def match(subject)
+        subject.class.plyushkin_model.ignore_unchanged_values[@attr_name]
+      end
+
+      def failure_message
+        message(true)
+      end
+
+      def negative_failure_message
+        message(false)
+      end
+
+      def message(negate)
+        "Plyushkin:: Hoarded attribute #{@attr_name} #{negate ? "ignores" : "does not ignore"} unchanged values"
+      end
+    end
+
+    class CallbackMatcher
+      def initialize(attr_name, callback)
+        @attr_name, @callback = attr_name, callback
+      end
+
+      def match(subject)
+        callbacks = subject.class.plyushkin_model.callbacks[@attr_name]
+        callbacks && (callbacks[:after_create] == @callback)
+      end
+
+      def failure_message
+        message(true)
+      end
+
+      def negative_failure_message
+        message(false)
+      end
+
+      def message(negate)
+        "Plyushkin:: Hoarded attribute #{@attr_name} #{negate ? "does not callback" : "calls back"} #{@callback}"
+      end
+    end
+  end
+end

data/lib/plyushkin/test/matcher_base.rb

@@ -0,0 +1,30 @@
+module Plyushkin::Test
+  class MatcherBase
+    def matchers
+      @matchers ||= []
+    end
+
+    def matches?(subject)
+      matchers.each do |m| 
+        unless m.match(subject) 
+          @failure_message          = m.failure_message 
+          @negative_failure_message = m.negative_failure_message 
+          break
+        end
+      end
+      return @failure_message.nil?
+    end
+
+    def failure_message
+      @failure_message
+    end
+
+    def negative_failure_message
+      @negative_failure_message
+    end
+
+    def description
+      "Description not set"
+    end
+  end
+end

data/lib/plyushkin/test/matchers.rb

@@ -0,0 +1,15 @@
+require_relative "matcher_base.rb"
+require_relative "persisted_attribute_matcher.rb"
+require_relative "hoarded_attribute_matcher.rb"
+
+module Plyushkin::Test
+  module Matchers
+    def persist_attribute(name)
+      Plyushkin::Test::PersistedAttributeMatcher.new(name) 
+    end
+
+    def hoard(attribute)
+      Plyushkin::Test::HoardedAttributeMatcher.new(attribute)
+    end
+  end
+end

data/lib/plyushkin/test/persisted_attribute_matcher.rb

@@ -0,0 +1,37 @@
+module Plyushkin::Test
+  class PersistedAttributeMatcher < Plyushkin::Test::MatcherBase
+    def initialize(attr_name)
+      @attr_name = attr_name
+    end
+
+    def with_format(formatter)
+      matchers << WithFormatMatcher.new(@attr_name, formatter)
+      self
+    end
+
+    def matches?(subject)
+      @failure_message          = "Plyushkin: no persisted attribute with name '#{@attr_name}'" unless subject.class.persisted_attributes.include?(@attr_name)
+      @negative_failure_message = "Plyushkin: persisted attribute with name '#{@attr_name}' exists" unless subject.class.persisted_attributes.include?(@attr_name)
+      super
+    end
+
+    class WithFormatMatcher
+      def initialize(attr_name, formatter)
+        @attr_name, @formatter = attr_name, formatter
+      end
+
+      def match(subject)
+        subject.class.formatters[@attr_name] == @formatter
+      end
+
+      def failure_message
+        "Plyushkin: attribute #{@attr_name} is not formatting with #{@formatter}"
+      end
+
+      def negative_failure_message
+        "Plyushkin: attribute #{@attr_name} is formatting with #{@formatter}"
+      end
+    end
+  end
+end
+

data/lib/plyushkin/test/value_types.rb

@@ -12,8 +12,18 @@ module Plyushkin::Test
   class Plyushkin::Test::Member < ActiveRecord::Base; end
   class Plyushkin::Test::WidgetOne < ActiveRecord::Base; hoards :apples; end
   class Plyushkin::Test::WidgetTwo < ActiveRecord::Base; hoards :beans; end
+  class Plyushkin::Test::IgnoresUnchangedWidget < ActiveRecord::Base
+    hoards :apples, :ignore_unchanged_values => true
+    hoards :beans
+  end
+
+  class Plyushkin::Test::CallbackWidget < ActiveRecord::Base
+    hoards :apples, :after_create => :core
+    hoards :beans
+  end
 
   class Plyushkin::Test::DateValue < Plyushkin::BaseValue
     persisted_attr :value, :formatter => :to_date
   end
+
 end

data/lib/plyushkin/version.rb

@@ -1,3 +1,3 @@
 module Plyushkin
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/lib/base_value_spec.rb

@@ -19,6 +19,31 @@ describe Plyushkin::BaseValue do
       value.should_not be_valid
       value.errors.full_messages.should == ["Date cannot be in the future"]
     end
+
+    it 'should be valid if date is equal to now' do
+      Timecop.freeze(DateTime.now) do
+        Plyushkin::StringValue.new.should be_valid
+      end
+    end
+
+    it 'should be valid if date is equal to current' do
+      Timecop.freeze(DateTime.current) do
+        Plyushkin::StringValue.new.should be_valid
+      end
+    end
+
+    describe '#numericality' do
+      it 'should not be valid if not an integer' do
+        clazz = Class.new(Plyushkin::StringValue) do
+          validates :value, :numericality => true
+        end
+        clazz.stub(:name).and_return("Clazz")
+
+        c = clazz.new
+        c.value = 'abcd'
+        c.should_not be_valid
+      end
+    end
   end
 
   describe '##persisted_attr' do
@@ -78,6 +103,48 @@ describe Plyushkin::BaseValue do
       value.my_attr.should == 5
       value.my_attr2.should == 9999
     end
+  end
+
+  describe 'formatter methods' do
+    describe '#to_i' do
+      it 'should return the same value if it contains non-numeric characters' do
+        Plyushkin::BaseValue.new.to_i("abcd").should == "abcd"
+      end
+
+      it 'should return an integer if string is a number' do
+        Plyushkin::BaseValue.new.to_i("1234").should == 1234
+      end
+
+      it 'should return an integer if arg is an integer' do
+        Plyushkin::BaseValue.new.to_i(1234).should == 1234
+      end
+
+      it 'should return nil when arg is nil' do
+        Plyushkin::BaseValue.new.to_i(nil).should be_nil
+      end
+    end
+
+    describe '#to_f' do
+      it 'should return the same value if it contains non-numeric characters' do
+        Plyushkin::BaseValue.new.to_f("abcd").should == "abcd"
+      end
+
+      it 'should return a float if string is a number' do
+        Plyushkin::BaseValue.new.to_f("12.34").should == 12.34
+      end
+
+      it 'should return a float if arg is a float' do
+        Plyushkin::BaseValue.new.to_f(123.4).should == 123.4
+      end
+
+      it 'should return a float if arg is an integer' do
+        Plyushkin::BaseValue.new.to_f(455).should == 455.0
+      end
+
+      it 'should return nil when arg is nil' do
+        Plyushkin::BaseValue.new.to_f(nil).should be_nil
+      end
+    end
 
     describe '#to_date' do
       it 'format a json string to a date' do
@@ -87,6 +154,24 @@ describe Plyushkin::BaseValue do
       end
     end
 
+    describe '#to_bool' do
+      it 'should return true if string true is passed in' do
+        Plyushkin::BaseValue.new.to_bool("true").should be_true
+      end
+
+      it 'should return false if string false is passed in' do
+        Plyushkin::BaseValue.new.to_bool("false").should be_false
+      end
+
+      it 'should return nil if nil is passed in' do
+        Plyushkin::BaseValue.new.to_bool(nil).should be_nil
+      end
+
+      it 'should return the same value if it cannot covert to boolean' do
+        Plyushkin::BaseValue.new.to_bool('railsconf').should == 'railsconf'
+      end
+    end
+
   end
 
   describe '#equal_value' do

data/spec/lib/core_ext/active_record_base_spec.rb

@@ -20,7 +20,7 @@ describe ActiveRecord::Base do
           hoards :geolocation, :type => Plyushkin::Test::CoordinateValue
         end
 
-        clazz.plyushkin_model.registered_types[:login_date].should be_nil
+        clazz.plyushkin_model.registered_types[:login_date].should  == Plyushkin::StringValue
         clazz.plyushkin_model.registered_types[:geolocation].should == Plyushkin::Test::CoordinateValue
       end
 

data/spec/lib/model_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Plyushkin::Model do
+  describe '#initialize' do
+    it 'should raise an error if no service is provided' do
+      expect {Plyushkin::Model.new(nil, 'name', nil)}
+        .to raise_error(Plyushkin::Error, /Service cannot be nil/)
+    end
+  end
+end

data/spec/lib/property_spec.rb

@@ -167,6 +167,19 @@ describe Plyushkin::Property do
     end
   end
 
+  describe '#nil?' do
+    it 'should be true if last value is NilValue' do
+      property = Plyushkin::Property.new(:property_name, :type => Plyushkin::Test::PresenceTestValue)
+      property.should be_nil
+    end
+
+    it 'should be false if last value is not a NilValue' do
+      property = Plyushkin::Property.new(:property_name, :type => Plyushkin::Test::PresenceTestValue)
+      property.create
+      property.should_not be_nil
+    end
+  end
+
   it '#insert_position' do
     property = Plyushkin::Property.new(:property_name)
     value1 = property.create(:value => 7, :date => DateTime.now - 7.days)

data/spec/lib/test/matchers_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Plyushkin::Test::DateValue do
+  it { should     persist_attribute(:value) }
+  it { should_not persist_attribute(:value2) }
+  it { should     persist_attribute(:value).with_format(:to_date) }
+  it { should_not persist_attribute(:value).with_format(:to_datetime) }
+end
+
+describe Plyushkin::Test::WidgetOne do
+  it { should     hoard(:apples) }
+  it { should     hoard(:apples).of_type(Plyushkin::StringValue) }
+  it { should_not hoard(:beans) }
+  it { should_not hoard(:apples).of_type(Plyushkin::Test::DateValue) }
+end
+
+describe Plyushkin::Test::IgnoresUnchangedWidget do
+  it { should  hoard(:apples).and_ignore_unchanged_values }
+  it { 
+    should     hoard(:beans)
+    should_not hoard(:beans).and_ignore_unchanged_values 
+  }
+end
+
+describe Plyushkin::Test::CallbackWidget do
+  it { should     hoard(:apples).of_type(Plyushkin::StringValue).and_after_create_call(:core) }
+  it { should     hoard(:apples) 
+       should_not hoard(:apples).and_after_create_call(:core2) }
+  it { should     hoard(:beans) 
+       should_not hoard(:beans).and_after_create_call(:core) }
+end

data/spec/spec_helper.rb

@@ -28,6 +28,7 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
+  config.include Plyushkin::Test::Matchers
 
   config.after(:each) do
     Plyushkin::Cache.cache.clear

data/spec/support/sqlite.rb

@@ -13,6 +13,12 @@ class CreateMembers < ActiveRecord::Migration
     create_table :widget_twos do |t|
       t.timestamps
     end
+    create_table :ignores_unchanged_widgets do |t|
+      t.timestamps
+    end
+    create_table :callback_widgets do |t|
+      t.timestamps
+    end
   end
 end
 CreateMembers.up

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plyushkin
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Craig Israel
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-31 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -31,7 +28,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -39,7 +35,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -47,17 +42,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Provides active record extension to capture historical property data
@@ -82,6 +75,7 @@ files:
 - lib/plyushkin/cache/stub.rb
 - lib/plyushkin/core_ext/active_record_base.rb
 - lib/plyushkin/core_ext/plyushkin_extensions.rb
+- lib/plyushkin/error.rb
 - lib/plyushkin/model.rb
 - lib/plyushkin/nil_value.rb
 - lib/plyushkin/persistence.rb
@@ -91,6 +85,10 @@ files:
 - lib/plyushkin/service/web.rb
 - lib/plyushkin/string_value.rb
 - lib/plyushkin/test.rb
+- lib/plyushkin/test/hoarded_attribute_matcher.rb
+- lib/plyushkin/test/matcher_base.rb
+- lib/plyushkin/test/matchers.rb
+- lib/plyushkin/test/persisted_attribute_matcher.rb
 - lib/plyushkin/test/value_types.rb
 - lib/plyushkin/validators/presence.rb
 - lib/plyushkin/version.rb
@@ -98,48 +96,51 @@ files:
 - spec/lib/base_value_spec.rb
 - spec/lib/cache/stub_spec.rb
 - spec/lib/core_ext/active_record_base_spec.rb
+- spec/lib/model_spec.rb
 - spec/lib/nil_value_spec.rb
 - spec/lib/persistence_spec.rb
 - spec/lib/property_spec.rb
 - spec/lib/service/stub_spec.rb
 - spec/lib/service/web_spec.rb
+- spec/lib/test/matchers_spec.rb
 - spec/lib/value_spec.rb
 - spec/spec_helper.rb
 - spec/support/sqlite.rb
 homepage: http://github.com/OnlifeHealth/plyushkin
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Plyushkin - the attribute hoarder
 test_files:
 - spec/lib/base_value_spec.rb
 - spec/lib/cache/stub_spec.rb
 - spec/lib/core_ext/active_record_base_spec.rb
+- spec/lib/model_spec.rb
 - spec/lib/nil_value_spec.rb
 - spec/lib/persistence_spec.rb
 - spec/lib/property_spec.rb
 - spec/lib/service/stub_spec.rb
 - spec/lib/service/web_spec.rb
+- spec/lib/test/matchers_spec.rb
 - spec/lib/value_spec.rb
 - spec/spec_helper.rb
 - spec/support/sqlite.rb