activerecord-hstore_properties 0.0.1.alpha

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/.idea

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-hstore_properties.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c)  stevo <blazejek@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 stevo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,76 @@
+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::Properties
+  properties 'third_name', 
+             'some_cool_feature' => :boolean, 
+             'comments' => :counter,
+             'age' => :number
+end
+
+
+h2. Usage
+
+By default, all your properties are of type String. There are number of other property types available though...
+
+# string
+# boolean
+# number
+# counter
+
+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!@
+
+
+h2. Updating through forms
+
+bc. <%= f.fields_for :properties, OpenStruct.new(@user.properties) do |builder| %>
+    <% User.properties.each do |property| %>
+       <%= builder.input property.name, property.formtastic_options %>
+    <% end %>
+<% end %>
+
+
+h2. Further customization
+
+If most of your properties are of the same type, but other than string, you can overwrite @default_proeprty_klass@ to make other type default, i.e.
+
+bc. 
+class User < ActiveRecord::Base
+#...
+  def default_property_klass
+    ActiveRecord::Properties::BooleanProperty
+  end
+end
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/activerecord-hstore_properties.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord-hstore_properties/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "activerecord-hstore_properties"
+  gem.version       = Activerecord::HstoreProperties::VERSION
+  gem.authors       = ["stevo"]
+  gem.email         = ["blazej.kosmowski@selle.com "]
+  gem.homepage      = "https://github.com//hstore-properties"
+  gem.summary       = "Facilitate defining and retrieving information from hstore column"
+  gem.description   = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+end

data/lib/active_record/hstore_properties.rb

@@ -0,0 +1,66 @@
+require "active_record/properties/base"
+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/extensions/booleans"
+require "active_record/properties/extensions/counters"
+
+module ActiveRecord
+  module HstoreProperties
+    extend ActiveSupport::Concern
+
+    included do
+     include ActiveRecord::Properties::Extensions::Booleans
+      include ActiveRecord::Properties::Extensions::Counters
+
+      serialize :properties, ::ActiveRecord::Coders::Hstore
+      class_attribute :_properties
+    end
+
+    def define_property_method(method_name, suffix, &block)
+      if method_name.ends_with?(suffix) and (self.class._properties.detect { |pn| pn.name.to_s == method_name.sub(suffix, '') })
+        prop_name = method_name.sub(suffix, '')
+        self.class.send(:define_method, method_name) do
+          block.call(prop_name, self)
+        end
+        [true, block.call(prop_name, self)]
+      else
+        [false, nil]
+      end
+    end
+
+    module ClassMethods
+      def properties(*args)
+        if args.blank?
+          self._properties ||= []
+        else
+          self._properties ||= []
+
+          new_properties = extract_properties(args)
+          self._properties += new_properties
+
+          new_properties.each do |property|
+            define_method("#{property.name.to_s}_property") { properties[property.name.to_s] }
+          end
+        end
+      end
+
+      def default_property_klass
+        ActiveRecord::Properties::StringProperty
+      end
+
+      private
+
+      def extract_properties(args)
+        typed_properties = args.extract_options!
+
+        result = args.map { |property| default_property_klass.new(property) }
+        typed_properties.each do |property, _type|
+          result << "active_record/properties/#{_type.to_s}_property".camelize.constantize.new(property)
+        end
+        result
+      end
+    end
+  end
+end

data/lib/active_record/properties/base.rb

@@ -0,0 +1,6 @@
+module ActiveRecord
+  module Properties
+    class Base < Struct.new(:name)
+    end
+  end
+end

data/lib/active_record/properties/boolean_property.rb

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

data/lib/active_record/properties/counter_property.rb

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

data/lib/active_record/properties/extensions/booleans.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  module Properties
+    module Extensions
+      module Booleans
+        def method_missing(*args, &block)
+          method_name = args.first.to_s
+          defined, result = define_property_method(method_name, '_enabled?') do |property_name, object|
+            ::ActiveRecord::ConnectionAdapters::Column.value_to_boolean(object.send("#{property_name}_property"))
+          end
+          defined ? result : super
+        end
+      end
+    end
+  end
+end

data/lib/active_record/properties/extensions/counters.rb

@@ -0,0 +1,28 @@
+# Allows fetching properties as numerical values by adding _count suffix
+
+module ActiveRecord
+  module Properties
+    module Extensions
+      module Counters
+        def method_missing(*args, &block)
+          method_name = args.first.to_s
+
+          defined, result = if method_name.ends_with?('_bump!')
+                              define_property_method(method_name, '_bump!') do |property_name, object|
+                                _properties = object.properties
+                                _properties[property_name] = object.send("#{property_name}_count") + 1
+                                object.update_column(:properties, ActiveRecord::Coders::Hstore.new({}).dump(_properties))
+                                _properties[property_name]
+                              end
+                            else
+                              define_property_method(method_name, '_count') do |property_name, object|
+                                object.send("#{property_name}_property").to_i
+                              end
+                            end
+
+          defined ? result : super
+        end
+      end
+    end
+  end
+end

data/lib/active_record/properties/number_property.rb

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module Properties
+      class NumberProperty < Base
+        def formtastic_options
+          {:as => :number}
+        end
+      end
+    end
+  end

data/lib/active_record/properties/string_property.rb

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module Properties
+      class StringProperty < Base
+        def formtastic_options
+          {:as => :string}
+        end
+      end
+    end
+  end

data/lib/activerecord-hstore_properties/version.rb

@@ -0,0 +1,5 @@
+module Activerecord
+  module HstoreProperties
+    VERSION = "0.0.1.alpha"
+  end
+end

data/lib/activerecord-hstore_properties.rb

@@ -0,0 +1,12 @@
+#
+#require 'active_support'
+#
+#if defined? Rails
+#  require "activerecord-hstore_properties/railties"
+#else
+#  ActiveSupport.on_load :active_record do
+#    require "activerecord-hstore_properties/activerecord"
+#  end
+#end
+require "activerecord-hstore_properties/version"
+require "active_record/hstore_properties"

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'activerecord-hstore_properties'

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'bundler/setup'
+

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-hstore_properties
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- stevo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: ''
+email:
+- ! 'blazej.kosmowski@selle.com '
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.textile
+- 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/counter_property.rb
+- lib/active_record/properties/extensions/booleans.rb
+- lib/active_record/properties/extensions/counters.rb
+- lib/active_record/properties/number_property.rb
+- lib/active_record/properties/string_property.rb
+- lib/activerecord-hstore_properties.rb
+- lib/activerecord-hstore_properties/version.rb
+- spec/spec_helper.rb
+- test/test_helper.rb
+homepage: https://github.com//hstore-properties
+licenses: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Facilitate defining and retrieving information from hstore column
+test_files:
+- spec/spec_helper.rb
+- test/test_helper.rb