activerecord-hstore_properties 0.0.4 → 0.0.5

data/README.md

@@ -0,0 +1,157 @@
+hstore-properties
+=================
+
+Setup
+-----
+
+Simply add following to your gemfile
+
+`gem 'hstore-properties'`
+
+Create `properties` column in the model you would like to use properties within, i.e.
+
+`rails g migration AddPropertiesToUsers properties:hstore`
+
+Apply your migration
+
+`rake db:migrate`
+
+Finally, describe your properties in your model file 
+
+```ruby
+class User < ActiveRecord::Base
+  include ActiveRecord::HstoreProperties
+  properties 'third_name', 
+             'some_cool_feature' => :boolean, 
+             'comments' => :counter,
+             'age' => :number
+end
+```
+
+Usage
+-----
+
+### Retrieving values
+
+By default, all your properties are of type String. There are number of other property types available though...
+
+* string
+* boolean
+* number
+* counter
+* translation
+
+More will come in near future...
+
+All properties can be retrieved just as they are written into hstore column, by suffixing them with `_property`, i.e.
+
+```ruby
+User.last.third_name_property #=> "Jack"
+```
+
+#### Booleans
+
+*Boolean* properties, can be additionaly retrieved by using `_enabled?` and `?` suffixes, that will cast them to boolean value, i.e.
+
+```ruby
+User.last.some_cool_feature_enabled? #=> true
+User.last.some_cool_feature? #=> true
+```
+
+What is more, you can toggle value of boolean property using `_enable!` / `_raise!` and `_disable!` / `_lower!` suffixes, e.g.
+
+```ruby
+User.last.some_cool_feature_enable! #=> Changes property to true
+User.last.some_cool_feature_raise! #=> Changes property to true
+User.last.some_cool_feature_disable! #=> Changes property to false
+User.last.some_cool_feature_lower! #=> Changes property to false
+```
+
+#### Counters
+
+*Counter* properties, can be retrieved by using `_count` suffix, that will cast them to integer value, i.e.
+
+```ruby
+User.last.comments_count #=> 10
+```
+
+What is more, it is possible to bump counter properties, i.e. following line will increment comments property by 1
+
+```ruby
+User.last.comments_bump!
+```
+
+#### Translations
+
+*Translation* kind of property allows you to store translated strings in properties column. 
+The simplest way to store translation is just assign it a value, and it will save it in current locale, e.g.
+
+```ruby
+class Category < ActiveRecord::Base
+  include ActiveRecord::HstoreProperties
+  properties 'caption' => :translation            
+end
+
+c = Category.last
+c.caption = "Nice product" #this will save 'Nice product' into caption_en property 
+c.save
+c.caption #this will retrieve 'Nice product' from caption_en property 
+```
+
+You can always enforce in which locale you would like to store property, by suffixing it with any locale code available in `I18n.available_locales`
+
+```ruby
+c = Category.last
+
+c.caption_en = "Nice product" 
+c.caption_nb_no = "Fint produkt" 
+
+c.save
+
+c.caption #=> "Nice product"
+c.caption_nb_no #=> "Fint produkt" 
+
+I18n.locale = :'nb-NO'
+c.caption #=> "Fint produkt" 
+```
+
+### Updating through forms
+
+You obviously need to add `:properties` to yours `attr_accessible`
+
+Below is an example of building appropriate fields dynamically with formtastic
+
+
+```erb
+<%= semantic_form_for @user do |f| %>
+    <%= f.first_name %>
+    <%= f.fields_for :properties, OpenStruct.new(@user.properties) do |builder| %>
+        <% User.properties.each do |property| %>
+            <%= builder.input property.name, property.formtastic_options %>
+        <% end %>
+    <% end %>
+    <%= f.submit %>
+<% end %>
+```
+
+Further customization
+---------------------
+
+If most of your properties are of the same type, but other than string, you can overwrite `default_property_klass` to make other type default, i.e.
+
+```ruby
+class User < ActiveRecord::Base
+#...
+  def self.default_property_klass
+    ActiveRecord::Properties::BooleanProperty
+  end
+end
+```
+
+When to use?
+------------
+
+* If you consider adding redundant column to your table, that will only sometimes store any data
+* If you would like to make particular model "configurable"
+* If you will not likely perform queries on specific field but mostly read from it directly
+

data/lib/active_record/hstore_properties.rb

@@ -1,10 +1,12 @@
 require 'active_support/core_ext/class'
 require 'active_support/concern'
 require "active_record/properties/base"
+require "active_record/properties/common_accessors"
 require "active_record/properties/boolean_property"
 require "active_record/properties/counter_property"
 require "active_record/properties/number_property"
 require "active_record/properties/string_property"
+require "active_record/properties/translation_property"
 
 module ActiveRecord
   module HstoreProperties
@@ -50,8 +52,8 @@ module ActiveRecord
             primary_method_name = method_names.shift
 
             #Define main method once...
-            define_method(primary_method_name) do
-              self.instance_exec(property, &proc)
+            define_method(primary_method_name) do |*args|
+              self.instance_exec(property, *args, &proc)
             end
 
             #... and then define aliases

data/lib/active_record/properties/base.rb

@@ -13,11 +13,6 @@ module ActiveRecord
           self._property_accessors = _property_accessors.merge(suffixes.to_a => block)
         end
       end
-
-      add_property_accessor '_property' do |property|
-        properties[property.name.to_s]
-      end
-
     end
   end
 end

data/lib/active_record/properties/boolean_property.rb

@@ -1,6 +1,8 @@
 module ActiveRecord
   module Properties
     class BooleanProperty < Base
+      include ActiveRecord::Properties::CommonAccessors
+
       def formtastic_options
         {:as => :boolean, :checked_value => 'true', :unchecked_value => 'false'}
       end

data/lib/active_record/properties/common_accessors.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  module Properties
+    module CommonAccessors
+      extend ActiveSupport::Concern
+      included do
+        add_property_accessor '_property' do |property|
+          properties[property.name.to_s]
+        end
+
+        add_property_accessor '=' do |property, *args|
+          properties_will_change!
+          properties[property.name.to_s] = args.shift
+        end
+      end
+    end
+  end
+end

data/lib/active_record/properties/counter_property.rb

@@ -1,6 +1,8 @@
 module ActiveRecord
   module Properties
     class CounterProperty < Base
+      include ActiveRecord::Properties::CommonAccessors
+
       def formtastic_options
         {:as => :number, :disabled => true}
       end

data/lib/active_record/properties/number_property.rb

@@ -1,6 +1,8 @@
 module ActiveRecord
   module Properties
     class NumberProperty < Base
+      include ActiveRecord::Properties::CommonAccessors
+
       def formtastic_options
         {:as => :number}
       end

data/lib/active_record/properties/string_property.rb

@@ -1,6 +1,8 @@
 module ActiveRecord
   module Properties
     class StringProperty < Base
+      include ActiveRecord::Properties::CommonAccessors
+
       def formtastic_options
         {:as => :string}
       end

data/lib/active_record/properties/translation_property.rb

@@ -0,0 +1,31 @@
+module ActiveRecord
+  module Properties
+    class TranslationProperty < Base
+      def formtastic_options
+        {:as => :string}
+      end
+
+      add_property_accessor '=' do |property, *args|
+        property_name = "#{property.name.to_s}_#{I18n.locale.to_s.underscore}"
+        properties[property_name] = args.shift
+      end
+
+      add_property_accessor '_property' do |property|
+        property_name = "#{property.name.to_s}_#{I18n.locale.to_s.underscore}"
+        properties[property_name]
+      end
+
+      I18n.available_locales.each do |locale|
+        add_property_accessor "_#{locale.to_s.underscore}" do |property|
+          property_name = "#{property.name.to_s}_#{locale.to_s.underscore}"
+          properties[property_name]
+        end
+
+        add_property_accessor "_#{locale.to_s.underscore}=" do |property, *args|
+          property_name = "#{property.name.to_s}_#{locale.to_s.underscore}"
+          properties[property_name] = args.shift
+        end
+      end
+    end
+  end
+end

data/lib/activerecord-hstore_properties/version.rb

@@ -1,5 +1,5 @@
 module Activerecord
   module HstoreProperties
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/hstore_properties_spec.rb

@@ -1,4 +1,6 @@
 require 'spec_helper'
+require 'activerecord-hstore_properties'
+
 describe ActiveRecord::HstoreProperties do
   with_model :Comment do
     table do |t|
@@ -8,7 +10,6 @@ describe ActiveRecord::HstoreProperties do
 
     model do
       include ActiveRecord::HstoreProperties
-
       #We need to do that, as sqlite does not support hstore
       self.class_eval do
         def properties
@@ -18,11 +19,11 @@ describe ActiveRecord::HstoreProperties do
     end
   end
 
-  it "it should respond to properties call" do
+  it "should respond to properties call" do
     Comment.respond_to?(:properties).should be_true
   end
 
-  it "it should be possible to define properties" do
+  it "should be possible to define properties" do
     Comment.properties 'property_one', 'property_two'
     Comment.properties.should be_an_instance_of(Array)
     Comment.properties.map(&:name).should include('property_one', 'property_two')
@@ -33,7 +34,7 @@ describe ActiveRecord::HstoreProperties do
     Comment.properties.first.should be_a_kind_of(ActiveRecord::Properties::StringProperty)
   end
 
-  it "it should be possible to define property types other than string" do
+  it "should be possible to define property types other than string" do
     Comment.properties 'property_one', 'property_two' => :boolean
     Comment.properties.find { |p| p.name == 'property_two' }.should be_a_kind_of(ActiveRecord::Properties::BooleanProperty)
   end
@@ -48,8 +49,16 @@ describe ActiveRecord::HstoreProperties do
 
   it "properties_set should not return underscored properties" do
     Comment.properties '_property_one', 'property_two'
-    Comment.properties_set.find{|p| p.name == '_property_one'}.should be_nil
-    Comment.properties_set.find{|p| p.name == 'property_two'}.should_not be_nil
+    Comment.properties_set.find { |p| p.name == '_property_one' }.should be_nil
+    Comment.properties_set.find { |p| p.name == 'property_two' }.should_not be_nil
+  end
+
+  it "should be possible to assign property value using simple accessor" do
+    Comment.properties 'property_two' => :boolean
+    comment = Comment.new
+    comment.property_two = true
+    comment.save
+    comment.property_two_property.should == 'true'
   end
 
   context "boolean properties" do
@@ -92,10 +101,43 @@ describe ActiveRecord::HstoreProperties do
     it "should be possible to query for current count" do
       @comment.property_two_count.should == 0
       @comment.property_two_bump!
-
       @comment.property_two_count.should == 1
     end
+  end
 
+  context "translation properties" do
+    before(:each) do
+      Comment.properties 'property_two' => :translation
+      @comment = Comment.new
+      @comment.save
     end
 
+    it "assigning a value should store it in current language scope" do
+      I18n.locale = :'en-GB'
+      @comment.property_two = "nice"
+      @comment.save
+
+      @comment.properties['property_two_en_gb'].should == 'nice'
+    end
+
+    it "retrieving raw value should take current locale into account" do
+      I18n.locale = :'en-GB'
+      @comment.property_two = "nice"
+      @comment.save
+
+      I18n.locale = :'nb-NO'
+      @comment.property_two_property.should be_nil
+      I18n.locale = :'en-GB'
+      @comment.property_two_property.should == 'nice'
+    end
+
+    it "should be possible to use direct readers and writers for all available locales" do
+      @comment.property_two_nb_no = 'Norwegian'
+      @comment.property_two_pl = 'Polish'
+      @comment.save
+
+      @comment.property_two_nb_no.should == 'Norwegian'
+      @comment.property_two_pl.should == 'Polish'
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,11 @@
-require 'activerecord-hstore_properties'
 require 'with_model'
 require 'active_record'
 require 'activerecord-postgres-hstore'
 require 'pry'
 
+#For later testing of translation properties
+I18n.available_locales = [:"nb-NO", :"en-GB", :pl]
+
 RSpec.configure do |config|
   ActiveRecord::Base.establish_connection(
       :adapter => 'sqlite3',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-hstore_properties
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-11 00:00:00.000000000 Z
+date: 2013-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -152,15 +152,17 @@ files:
 - Gemfile
 - LICENSE
 - LICENSE.txt
-- README.textile
+- README.md
 - Rakefile
 - activerecord-hstore_properties.gemspec
 - lib/active_record/hstore_properties.rb
 - lib/active_record/properties/base.rb
 - lib/active_record/properties/boolean_property.rb
+- lib/active_record/properties/common_accessors.rb
 - lib/active_record/properties/counter_property.rb
 - lib/active_record/properties/number_property.rb
 - lib/active_record/properties/string_property.rb
+- lib/active_record/properties/translation_property.rb
 - lib/activerecord-hstore_properties.rb
 - lib/activerecord-hstore_properties/version.rb
 - spec/hstore_properties_spec.rb

data/README.textile

@@ -1,93 +0,0 @@
-h1. hstore-properties
-
-
-h2. Setup
-
-
-Simply add following to your gemfile
-
-@gem 'hstore-properties'@
-
-Create @properties@ column in the model you would like to use properties within, i.e.
-
-@rails g migration AddPropertiesToUsers properties:hstore@
-
-Apply your migration
-
-@rake db:migrate@
-
-Finally, describe your properties in your model file 
-
-bc. class User < ActiveRecord::Base
-  include ActiveRecord::HstoreProperties
-  properties 'third_name', 
-             'some_cool_feature' => :boolean, 
-             'comments' => :counter,
-             'age' => :number
-end
-
-
-h2. Usage
-
-h3. Retrieving values
-
-By default, all your properties are of type String. There are number of other property types available though...
-
-* string
-* boolean
-* number
-* counter
-
-More will come in near future...
-
-All properties can be retrieved just as they are written into hstore column, by suffixing them with @_property@, i.e.
-
-@User.last.third_name_property #=> "Jack"@
-
-*Boolean* properties, can be additionaly retrieved by using @_enabled?@ suffix, that will cast them to boolean value, i.e.
-
-@User.last.some_cool_feature_enabled? #=> true@
-
-*Counter* properties, can be retrieved by using @_count@ suffix, that will cast them to integer value, i.e.
-
-@User.last.comments_count #=> 10@
-
-What is more, it is possible to bump counter properties, i.e. following line will increment comments property by 1
-
-@User.last.comments_bump!@
-
-
-h3. Updating through forms
-
-You obviously need to add @:properties@ to yours @attr_accessible@
-
-Below is an example of building appropriate fields dynamically with formtastic
-
-bc.. <%= semantic_form_for @user do |f| %>
-    <%= f.first_name %>
-    <%= f.fields_for :properties, OpenStruct.new(@user.properties) do |builder| %>
-        <% User.properties.each do |property| %>
-            <%= builder.input property.name, property.formtastic_options %>
-        <% end %>
-    <% end %>
-    <%= f.submit %>
-<% end %>
-
-h2. Further customization
-
-If most of your properties are of the same type, but other than string, you can overwrite @default_property_klass@ to make other type default, i.e.
-
-bc. 
-class User < ActiveRecord::Base
-#...
-  def self.default_property_klass
-    ActiveRecord::Properties::BooleanProperty
-  end
-end
-
-h2. When to use?
-
-* If you consider adding redundant column to your table, that will only sometimes store any data
-* If you would like to make particular model "configurable"
-* If you will not likely perform queries on specific field but mostly read from it directly
-