redis-model-extension 0.4.1 → 0.4.2

data/README.markdown

@@ -161,9 +161,22 @@ TestRedisModel.find_by_token :field4=> true
 #=> [<TestRedisModel: ...>, <TestRedisModel: ...>, ...]
 ```
 
+## Dirty
+
+If you want to use ActiveModel::Dirty, i.e. methods like `_changed?`, `_was?` you can include
+a Dirty module to your model (right after RedisModelExtension)
+```ruby
+class MyModel
+  include RedisModelExtension
+  include RedisModelExtension::Dirty
+end
+```
 
 ## Change log
 
+* 0.4.2 
+ * Add ActiveModel::Dirty
+ * Change work with attributes to ActiveModel::Attributes
 * 0.4.1 
  * Fixed bugs in intialization
  * Changed aliases to use key - array instead of key - value (enable find by category...) WIKI: [Aliases](https://github.com/ondrejbartas/redis-model-extension/wiki/Aliases)
@@ -197,4 +210,4 @@ TestRedisModel.find_by_token :field4=> true
 ## Copyright
 
 Copyright (c) 2012 Ondrej Bartas. See LICENSE.txt for
-further details.
+further details.

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

data/lib/redis-model-extension.rb

@@ -68,5 +68,6 @@ require 'redis-model-extension/attributes'
 require 'redis-model-extension/save_destroy'
 require 'redis-model-extension/store_keys'
 require 'redis-model-extension/autoincrement_id'
+require 'redis-model-extension/dirty'
 #bad naming in past, will be removed
 require 'redis-model'

data/lib/redis-model-extension/attributes.rb

@@ -20,19 +20,24 @@ module RedisModelExtension
     def to_json
       to_arg.to_json
     end
-    
 
-    private 
+    private
 
     # get value from instance variable
     def value_get name
       instance_variable_get(:"@#{name}")
     end
+    alias :attribute :value_get
 
     # set value into instance variable
     def value_set name, value
       instance_variable_set(:"@#{name}", value_parse(value, redis_fields_defaults_config[name]))
     end
+    alias :attribute= :value_set
+
+    def attribute?(name)
+      value_get(name) && !value_get(name).blank? ? true : false
+    end
 
   end
-end
+end

data/lib/redis-model-extension/dirty.rb

@@ -0,0 +1,43 @@
+# -*- encoding : utf-8 -*-
+module RedisModelExtension
+
+  # == Dirty
+  # module for easier detection of changed attributes
+  #
+  # if you want it in your model include it after RedisModelExtension, i.e.
+  #
+  #  class MyModel
+  #    include RedisModelExtension
+  #    include RedisModelExtension::Dirty
+  #  end
+  module Dirty
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveModel::Dirty
+    end
+
+    def attribute=(name, value)
+      attribute_will_change!(name) unless value == attribute(name)
+      super
+    end
+
+    def save
+      if result = super
+        @previously_changed = changes
+        @changed_attributes.clear
+      end
+      result
+    end
+
+    module ClassMethods
+      # hook to reset changed attributes, when load by .find or .get
+      def new_by_key(key)
+        new_instance = super
+        new_instance.changed_attributes.clear
+        new_instance
+      end
+    end
+
+  end
+end

data/lib/redis-model-extension/initialize.rb

@@ -19,23 +19,11 @@ module RedisModelExtension
 
       # remember field to save into redis
       redis_fields_config[name] = type
+
       # remember field default value
       redis_fields_defaults_config[name] = default
 
-      # get value
-      define_method name do
-        value_get name  
-      end
-
-      # assign new value
-      define_method "#{name}=" do |new_value|
-        value_set name, new_value
-      end
-
-      # value exists? (not nil and not blank?)
-      define_method "#{name}?" do 
-        value_get(name) && !value_get(name).blank? ? true : false
-      end
+      define_attribute_methods [name]
     end
 
     def set_redis_autoincrement_key
@@ -151,9 +139,18 @@ module RedisModelExtension
     included do
       redis_save_fields_with_nil true
       set_redis_autoincrement_key
+
+      include ActiveModel::AttributeMethods
+      # just `attribute` is defined automatically
+      attribute_method_suffix '='
+      attribute_method_suffix '?'
+    end
+
+    def attribute_method?(attr_name)
+      self.class.redis_user_field_config.include? attr_name.to_sym
     end
 
-    # initialize instance    
+    # initialize instance
     def initialize(args={})
       args = HashWithIndifferentAccess.new(args)
       # look for fields in input hash
@@ -162,11 +159,12 @@ module RedisModelExtension
         raise ArgumentError, "You cannot specify #{key} (it is auto incremented)" if args[key] && type == :autoincrement && get_last_id.to_i < args[key].to_i
 
         # input hash has known field
-        if args.has_key?(key) 
-          value_set key, value_parse(args[key], type)
+        value = if args.has_key?(key)
+          value_parse(args[key], type)
         else #there is no value set default valued
-          value_set key, redis_fields_defaults_config[key]
+          redis_fields_defaults_config[key]
         end
+        send(:attribute=, key, value)
       end
 
       return self

data/redis-model-extension.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "redis-model-extension"
-  s.version = "0.4.1"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ondrej Bartas"]
-  s.date = "2012-08-30"
+  s.date = "2012-09-01"
   s.description = "It provides functions as find, find_by_alias, get, exists?, validate, save etc."
   s.email = "ondrej@bartas.cz"
   s.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     "lib/redis-model-extension/attributes.rb",
     "lib/redis-model-extension/autoincrement_id.rb",
     "lib/redis-model-extension/config.rb",
+    "lib/redis-model-extension/dirty.rb",
     "lib/redis-model-extension/get_find.rb",
     "lib/redis-model-extension/initialize.rb",
     "lib/redis-model-extension/old_initialize.rb",
@@ -48,6 +49,7 @@ Gem::Specification.new do |s|
     "test/redis_model_old/test_redis_model_old_config.rb",
     "test/redis_model_parts/test_attributes.rb",
     "test/redis_model_parts/test_autoincrement_id.rb",
+    "test/redis_model_parts/test_dirty.rb",
     "test/redis_model_parts/test_dynamic_alias.rb",
     "test/redis_model_parts/test_get_find.rb",
     "test/redis_model_parts/test_hooks.rb",

data/test/models.rb

@@ -96,3 +96,14 @@ class NilTestOldRedisModel
   include RedisModel
   initialize_redis_model_methods REDIS_MODEL_CONF
 end
+
+class WithDirty
+  include RedisModelExtension
+  include RedisModelExtension::Dirty
+
+  redis_field :first_field,  :string
+  redis_field :second_field, :bool
+  redis_field :third_field,  :integer
+
+  redis_key :first_field
+end

data/test/redis_model_parts/test_dirty.rb

@@ -0,0 +1,65 @@
+# -*- encoding : utf-8 -*-
+require 'helper'
+class DirtyTest < Test::Unit::TestCase
+  context 'Dirty' do
+    setup do
+      @time = Time.now
+      @args = {
+        :first_field => 'foo',
+        :second_field => true,
+        :third_field => 100,
+      }
+      @test_model = WithDirty.create(@args)
+    end
+
+    context 'after initialize' do
+      should 'be dirty' do
+        @test_model = WithDirty.new(@args)
+
+        assert @test_model.changed?
+        assert_same_elements @args.keys, @test_model.changed
+
+        @test_model.changes.each do |key,value|
+          assert value[0].nil?
+          assert_equal @args[key], value[1]
+        end
+      end
+    end
+
+    context 'after load' do
+      should 'be clean' do
+        @model = WithDirty.get(first_field: 'foo')
+
+        refute @model.changed?
+        refute @model.changed.any?
+      end
+
+      context '& after modifying' do
+        setup do
+          @model = WithDirty.get(first_field: 'foo')
+          @model.first_field = 'bar'
+        end
+
+        should 'be dirty' do
+          assert @model.changed?
+          assert_equal ['first_field'], @model.changed
+          assert @model.first_field_changed?
+          assert_equal ['foo', 'bar'], @model.first_field_change
+          assert_equal 'foo', @model.first_field_was
+        end
+
+        context ' & after save' do
+          should 'be clean once again' do
+            @model.save
+            refute @model.changed?
+            refute @model.changed.any?
+
+            # just to be sure it successfully saved itself
+            assert WithDirty.get(first_field: 'bar')
+          end
+        end
+      end
+
+    end
+  end
+end

data/test/redis_model_parts/test_initialize.rb

@@ -41,6 +41,11 @@ class VariableTypesTest < Test::Unit::TestCase
       assert @test_model.respond_to?(:"float?")
     end    
 
+    should "say if class has attribute method" do
+      assert TestRedisModel.attribute_method?(:integer)
+      refute TestRedisModel.attribute_method?(:nonexisting)
+    end
+
   end
 end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-model-extension
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-30 00:00:00.000000000 Z
+date: 2012-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70323131409560 !ruby/object:Gem::Requirement
+  requirement: &70278847900060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70323131409560
+  version_requirements: *70278847900060
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70323131409020 !ruby/object:Gem::Requirement
+  requirement: &70278847899200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70323131409020
+  version_requirements: *70278847899200
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70323131408240 !ruby/object:Gem::Requirement
+  requirement: &70278847898100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70323131408240
+  version_requirements: *70278847898100
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70323131407640 !ruby/object:Gem::Requirement
+  requirement: &70278847897540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70323131407640
+  version_requirements: *70278847897540
 - !ruby/object:Gem::Dependency
   name: hashr
-  requirement: &70323131407100 !ruby/object:Gem::Requirement
+  requirement: &70278847896760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70323131407100
+  version_requirements: *70278847896760
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70323131406320 !ruby/object:Gem::Requirement
+  requirement: &70278847829920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131406320
+  version_requirements: *70278847829920
 - !ruby/object:Gem::Dependency
   name: shoulda-context
-  requirement: &70323131405480 !ruby/object:Gem::Requirement
+  requirement: &70278847829180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131405480
+  version_requirements: *70278847829180
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70323131404320 !ruby/object:Gem::Requirement
+  requirement: &70278847828360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131404320
+  version_requirements: *70278847828360
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70323131403740 !ruby/object:Gem::Requirement
+  requirement: &70278847827620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131403740
+  version_requirements: *70278847827620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70323131402900 !ruby/object:Gem::Requirement
+  requirement: &70278847827020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131402900
+  version_requirements: *70278847827020
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70323131402080 !ruby/object:Gem::Requirement
+  requirement: &70278847826340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131402080
+  version_requirements: *70278847826340
 - !ruby/object:Gem::Dependency
   name: sdoc
-  requirement: &70323131671260 !ruby/object:Gem::Requirement
+  requirement: &70278847825660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131671260
+  version_requirements: *70278847825660
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70323131670560 !ruby/object:Gem::Requirement
+  requirement: &70278847825060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131670560
+  version_requirements: *70278847825060
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70323131669940 !ruby/object:Gem::Requirement
+  requirement: &70278847824520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131669940
+  version_requirements: *70278847824520
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &70323131669400 !ruby/object:Gem::Requirement
+  requirement: &70278847824000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,10 +175,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131669400
+  version_requirements: *70278847824000
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70323131668760 !ruby/object:Gem::Requirement
+  requirement: &70278847823520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -186,10 +186,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131668760
+  version_requirements: *70278847823520
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &70323131668020 !ruby/object:Gem::Requirement
+  requirement: &70278847823020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -197,7 +197,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323131668020
+  version_requirements: *70278847823020
 description: It provides functions as find, find_by_alias, get, exists?, validate,
   save etc.
 email: ondrej@bartas.cz
@@ -221,6 +221,7 @@ files:
 - lib/redis-model-extension/attributes.rb
 - lib/redis-model-extension/autoincrement_id.rb
 - lib/redis-model-extension/config.rb
+- lib/redis-model-extension/dirty.rb
 - lib/redis-model-extension/get_find.rb
 - lib/redis-model-extension/initialize.rb
 - lib/redis-model-extension/old_initialize.rb
@@ -238,6 +239,7 @@ files:
 - test/redis_model_old/test_redis_model_old_config.rb
 - test/redis_model_parts/test_attributes.rb
 - test/redis_model_parts/test_autoincrement_id.rb
+- test/redis_model_parts/test_dirty.rb
 - test/redis_model_parts/test_dynamic_alias.rb
 - test/redis_model_parts/test_get_find.rb
 - test/redis_model_parts/test_hooks.rb
@@ -264,7 +266,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4312848391343916827
+      hash: -27895008965142288
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: