opinionated 0.0.1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'rails', '>= 3.1.0'
+gem 'pg'
+gem 'activerecord-postgres-hstore', '>= 0.3.0' 

data/Gemfile.lock

@@ -0,0 +1,91 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.3)
+      actionpack (= 3.2.3)
+      mail (~> 2.4.4)
+    actionpack (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activerecord-postgres-hstore (0.3.0)
+      activerecord
+      rake
+    activeresource (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    json (1.7.3)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    multi_json (1.3.6)
+    pg (0.13.2)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.3)
+      actionmailer (= 3.2.3)
+      actionpack (= 3.2.3)
+      activerecord (= 3.2.3)
+      activeresource (= 3.2.3)
+      activesupport (= 3.2.3)
+      bundler (~> 1.0)
+      railties (= 3.2.3)
+    railties (3.2.3)
+      actionpack (= 3.2.3)
+      activesupport (= 3.2.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-postgres-hstore (>= 0.3.0)
+  pg
+  rails (>= 3.1.0)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Lantirn, Inc.
+
+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.md

@@ -0,0 +1,4 @@
+opinionated
+===========
+
+Adds defaults and a sensible interface to activerecord-postgres-hstore

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the opinionated gem'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the opinionated gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Opinionated'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/opinionated.rb

@@ -0,0 +1,145 @@
+require 'opinionated/definition'
+require 'opinionated/configuration'
+require 'opinionated/helpers'
+require 'opinionated/hash'
+
+module Reamaze
+  module Opinionated
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    # Make methods available to ActiveRecord in the class context
+    module ClassMethods
+      def preferences(preferential = :preferences, options = {})
+        send :include, InstanceMethods
+
+        preferential = Helpers.normalize(preferential)
+
+        # Create accessor methods to our configuration info
+        class << self
+          attr_accessor :preferential_configuration unless method_defined?(:preferential_configuration)
+        end
+
+        # Initialize the configuration to an empty hash
+        self.preferential_configuration = {} if self.preferential_configuration.nil?
+
+        # Redefining a preference configuration once defined should not be allowed
+        raise ArgumentError, "#{self} class already preferences :#{preferential} defined" if self.preferential_configuration.has_key?(preferential)
+
+        configuration = Configuration.new(self, preferential, options)
+        yield configuration
+        preferential_configuration[preferential] = configuration
+
+        # override hstore Hash with a custom Hash
+        class_eval do 
+          eval(
+            <<-EOS
+              def #{preferential}
+                h = Reamaze::Opinionated::Hash.new self, "#{preferential}"
+                h.replace self["#{preferential}"].from_hstore if self["#{preferential}"]
+                h
+              end
+            EOS
+          )
+        end
+      end
+    end
+
+    # Make methods available to ActiveRecord models in the instance context
+    module InstanceMethods
+      # we can't use alias chaining because Rails loads method_missing dynamically
+      def method_missing(id, *args, &block)
+        self.class.preferential_configuration.keys.each do |key|
+          # checker
+          match = /#{key}_(.+)\?/.match(id.to_s)
+          return !!get_preferential(key, match[1], true) if match
+
+          # setter
+          match = /#{key}_(.+)=/.match(id.to_s)
+          return set_preferential key, match[1], args[0], true if match
+
+          # getter
+          match = /#{key}_(.+)/.match(id.to_s)
+          return get_preferential key, match[1], true if match
+        end
+        
+        super
+      end
+
+      def set_preferential(preferential, name, value, do_preprocess = false)
+        preferential = Helpers.normalize(preferential)
+        name = Helpers.normalize(name)
+
+        # Check to make sure the preferential exists
+        raise ArgumentError, "Preference #{preferential} is not defined for class #{self.class}" \
+          unless self.class.preferential_configuration.has_key?(preferential)
+        
+        configuration = self.class.preferential_configuration[preferential]
+        definition = configuration.definitions[name]
+
+        # Do preprocess here, type_check and validate can be done as AR validation in
+        value = definition.preprocess.call(value) if do_preprocess and definition and definition.has_preprocess
+
+        # Invoke the association
+        prefs = ::Hash[self[preferential].from_hstore] if self[preferential]
+
+        if prefs.blank?
+          send(preferential + '=', {name => value})
+          prefs = send(preferential)
+        else
+          prefs[name] = value
+          send(preferential + '=', prefs)
+        end
+        
+        prefs[name]
+      end
+
+      def get_preferential(preferential, name, do_postprocess = false)
+        preferential = Helpers.normalize(preferential)
+        name = Helpers.normalize(name)
+
+        # Check to make sure the preferential exists
+        raise ArgumentError, "Preference #{preferential} not defined for class #{self.class}" \
+          unless self.class.preferential_configuration.has_key?(preferential)
+        
+        configuration = self.class.preferential_configuration[preferential]
+        definition = configuration.definitions[name]
+
+        # Invoke the association
+        prefs = self[preferential].from_hstore if self[preferential]
+        prefs = {} if prefs.blank?
+
+        # Try to find what they are looking for
+        pref = prefs[name]
+
+        # If the pref isn't found, try to fallback on a default
+        if pref.blank? and definition
+          # TODO break all these nested if statements out into helper methods, i like prettier code
+          # TODO raise an exception if we don't respond to default_through or the resulting object doesn't respond to the preferential
+          if definition.has_default_through and respond_to?(definition.default_through) and (through = send(definition.default_through)).blank? == false
+            value = through.send(preferential)[name]
+          elsif definition.has_default_dynamic
+            if definition.default_dynamic.instance_of?(Proc)
+              value = definition.default_dynamic.call(self)
+            else
+              # TODO raise an exception if we don't respond to default_dynamic
+              value = send(definition.default_dynamic)
+            end
+          elsif definition.has_default
+            value = Marshal::load(Marshal.dump(definition.default)) # BUGFIX deep cloning default values
+          else
+            value = nil
+          end
+        else
+          value = pref
+        end
+
+        value = definition.postprocess.call(value) if do_postprocess and definition and definition.has_postprocess
+        value
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Reamaze::Opinionated

data/lib/opinionated/configuration.rb

@@ -0,0 +1,19 @@
+module Reamaze
+  module Opinionated
+    class Configuration
+      attr_accessor :definitions
+
+      def initialize(klass, preferential, options)
+        @klass        = klass
+        @preferential = preferential
+        @definitions  = {}
+      end
+
+      def define(preferential, options = {})
+        preferential = Helpers.normalize(preferential)
+        raise ArgumentError, "#{@klass} already defines preferences :#{preferential}" if @definitions.has_key?(preferential)
+        @definitions[preferential] = Definition.new(preferential, options)
+      end
+    end
+  end
+end

data/lib/opinionated/definition.rb

@@ -0,0 +1,55 @@
+module Reamaze
+  module Opinionated
+    class Definition
+      attr_accessor :name
+      attr_accessor :has_type_check,      :type_check
+      attr_accessor :has_validate,        :validate
+      attr_accessor :has_default,         :default
+      attr_accessor :has_default_through, :default_through
+      attr_accessor :has_default_dynamic, :default_dynamic
+      attr_accessor :has_preprocess,      :preprocess
+      attr_accessor :has_postprocess,     :postprocess
+
+      def initialize(name, options = {})
+        @name = name
+
+        if options.has_key?(:type_check)
+          @has_type_check = true
+          @type_check = options[:type_check].instance_of?(Array) ? options[:type_check] : [options[:type_check]]
+        end
+
+        if options.has_key?(:validate)
+          @has_validate = true
+          @validate = options[:validate]
+        end
+
+        if options.has_key?(:default)
+          @has_default = true
+          @default = options[:default]
+        end
+
+        if options.has_key?(:default_through)
+          @has_default_through = true
+          @default_through = options[:default_through]
+        end
+
+        if options.has_key?(:default_dynamic)
+          @has_default_dynamic = true
+          @default_dynamic = options[:default_dynamic]
+        end
+
+        if options.has_key?(:preprocess)
+          @has_preprocess = true
+          @preprocess = options[:preprocess]
+        end
+
+        if options.has_key?(:postprocess)
+          @has_postprocess = true
+          @postprocess = options[:postprocess]
+        end
+
+      end
+
+    end
+  end
+end

data/lib/opinionated/hash.rb

@@ -0,0 +1,29 @@
+module Reamaze
+  module Opinionated
+    class Hash < ::Hash
+      def initialize(owner, preferential)
+        @owner = owner
+        @preferential = preferential
+      end
+
+      def [] key
+        @owner.get_preferential @preferential, key.to_s, true
+      end
+
+      def []= key, value
+        @owner.set_preferential @preferential, key.to_s, value, true
+        super key.to_s, value
+      end
+
+      def method_missing(id, *args, &block)
+        match = /(.+)=$/.match id.to_s
+        return self[match[1]] = args[0] if match
+        
+        match = /(.+)\?$/.match id.to_s
+        return !!self[match[1]] if match
+        
+        self[id]
+      end 
+    end
+  end
+end

data/lib/opinionated/helpers.rb

@@ -0,0 +1,10 @@
+module Reamaze
+  module Opinionated
+    module Helpers
+      # Converts give symbol to string and downcases it
+      def self.normalize(symbol)
+        symbol.to_s.downcase
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: opinionated
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Lu Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-31 00:00:00 Z
+dependencies: []
+
+description: 
+email: 
+- lwang@reamaze.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/opinionated/configuration.rb
+- lib/opinionated/definition.rb
+- lib/opinionated/hash.rb
+- lib/opinionated/helpers.rb
+- lib/opinionated.rb
+- MIT-LICENSE
+- README.md
+- Gemfile
+- Gemfile.lock
+- Rakefile
+homepage: http://github.com/lunaru/opinionated
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Adds defaults and a sensible interface to activerecord-postgres-hstore
+test_files: []
+