hash_accessor 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright on Updates - Copyright (c) 2011 OctopusApp Inc. (http://getjobber.com), released under the 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.rdoc

@@ -0,0 +1,65 @@
+= HashAccessor
+
+This gem provides accessor methods to hash keys. 
+
+The purpose behind building HashAccessor was to be able to quickly add/modify/remove variables being stored in a serialized hash of a rails model. This is very useful if you have a large list of often changing variables on a model which don't get queried against. You can create new variables without messing up your DB. Storing account configurations or custom themes is a common scenario.
+
+== Installation 
+
+In your <code>Gemfile</code>:
+
+  gem "hash_accessor"
+
+Then run:
+  
+  bundle install
+  
+== Usage
+
+You define each accessor you want to be stored inside the serialized hash
+
+<code>hash_accessor _NAME_OF_HASH_, _NAME_OF_VARIABLE_, options</code>
+
+Here is an example:
+
+  class MyModel < ActiveRecord::Base
+    serialize :options, Hash
+
+    hash_accessor :options, :currency, :default => "$USD"
+    hash_accessor :options, :display_currency_on_invoices, :type => :boolean, :default => true
+    hash_accessor :options, :invoice_due_date_net, :type => :integer, :default => 3
+    
+    
+    def some_method
+    
+      self.currency = "$CAD"
+      
+      display_currency_on_invoices?
+      
+      ...
+    end
+    
+  end
+
+=== Valid Options:
+
+<code>:default</code> - if undefined, this plugin will create an empty instance of the defined type or null
+
+<code>:type</code> - defaults to :string. Can also be :integer, :float, :boolean, or :array
+
+==== For Arrays only:
+<code>:collects</code> - only runs on arrays. Calls the lambda method on each item in the array before saving
+
+<code>:reject_blanks</code> - removes all blank elements after the collect method
+
+
+
+== Contributing & Reporting Issues
+
+While I can't promise the most speedy response, I do plan to continue to maintain this gem. Please feel free to report any issues, provide feedback, or make suggestions on the {Issue Tracker}[http://github.com/forrest/hash_accessor/issues]
+
+
+---
+
+
+Copyright on Updates - Copyright (c) 2011 OctopusApp Inc. ({getjobber.com}[http://getjobber.com]), released under the MIT license

data/hash_accessor.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path("../lib/hash_accessor", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "hash_accessor"
+  s.version = HashAccessor::VERSION
+  s.author = ["Forrest"]
+  s.email = ["development@forrestzeisler.com"]
+  s.date = Time.now.utc.strftime("%Y-%m-%d")
+  
+  
+  s.description = 'This gem provides accessor methods to hash keys.'
+  s.summary = "This gem provides extended functionality to serialized hashed in rails. It allows you to define accessor methods for variable that rest "+
+              "inside a serialized hash. This is very useful if you have a large list of often changing DB variables on a model which don't get queried against."
+  
+  s.required_rubygems_version = ">= 1.3.6"
+  s.platform = Gem::Platform::RUBY
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path  = "lib"
+  
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc"]
+end

data/lib/class_methods.rb

@@ -0,0 +1,88 @@
+module HashAccessor
+  module ClassMethods
+    #valid options:
+    # :default - if undefined, this plugin will create an empty instance of the defined type or null
+    # :type - defaults to :string. Can also be :integer, :float, :boolean, or :array
+    #
+    # for arrays only:
+    # :collects - only runs on arrays. Calls the lambda method on each item in the array before saving
+    # :reject_blanks - removes all blank elements after the collect method
+    def hash_accessor(hash_name, method_name, options = {})
+      method_modifier = ""
+      begin
+      
+        if options[:type]==:integer
+          method_modifier = "new_val = new_val.to_i"
+        elsif options[:type]==:float
+          method_modifier = "new_val = new_val.to_f"
+        elsif options[:type]==:boolean or options[:type]==:bool
+          method_modifier = "new_val = (new_val.is_a?(TrueClass) or (new_val.is_a?(String) and (new_val=~/true|1/i).present?) or (new_val.is_a?(Fixnum) and new_val==1))"
+        elsif options[:type]==:array
+          method_modifier = "new_val = [new_val] unless new_val.is_a?(Array)"
+
+          if options[:collects]
+            self.class_variable_set("@@lambda_for_#{method_name}", options[:collects])
+            method_modifier += "\nnew_val = new_val.collect(&@@lambda_for_#{method_name})"
+          end
+        
+          if options[:reject_blanks]
+            method_modifier += "\nnew_val = new_val.reject(&:blank?)"
+          end
+        end
+
+
+
+        if options[:default].is_a?(String)
+          default = "\"#{options[:default]}\""
+        elsif options[:default].nil? and options[:type]==:array
+          default = "[]"
+        elsif options[:default].nil?
+          default = "nil"
+        else
+          default = options[:default]
+        end
+
+str = <<-EOS
+def #{method_name}
+self.#{hash_name} ||= {}
+
+if self.#{hash_name}[:#{method_name}].nil?
+  self.#{hash_name}[:#{method_name}] = #{default}
+end
+
+self.#{hash_name}[:#{method_name}]
+end
+
+def #{method_name}=(new_val)
+self.#{hash_name} ||= {}
+#{method_modifier}
+
+if self.#{hash_name}[:#{method_name}] != new_val
+  @#{method_name}_changed = true
+end
+
+self.#{hash_name}[:#{method_name}] = new_val
+end
+
+def #{method_name}_changed?
+!!@#{method_name}_changed
+end
+EOS
+
+        if options[:type]==:boolean or options[:type]==:bool
+str += <<-EOS
+def #{method_name}?
+!!self.#{method_name}
+end
+EOS
+        end
+
+        class_eval str
+      rescue Exception => e
+        puts "\n\nError adding hash_accessor:\n#{e.message}\n#{e.backtrace}\n\n"
+      end
+    
+    end
+  end
+  
+end

data/lib/hash_accessor.rb

@@ -0,0 +1,15 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'railtie' if defined?(Rails)
+
+module HashAccessor
+  VERSION = "0.0.1"
+  
+  autoload :ClassMethods, 'class_methods'  
+  
+  def self.included(mod)
+    mod.extend(ClassMethods)
+  end
+
+end

data/lib/railtie.rb

@@ -0,0 +1,9 @@
+module HashAccessor
+  class Railtie < Rails::Railtie
+
+    config.to_prepare do
+      ActiveRecord::Base.send :include HashAccessor      
+    end
+    
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require File.expand_path('/../lib/hash_accessor', File.dirname(__FILE__))
+

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: hash_accessor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Forrest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-16 00:00:00.000000000Z
+dependencies: []
+description: This gem provides accessor methods to hash keys.
+email:
+- development@forrestzeisler.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- hash_accessor.gemspec
+- lib/class_methods.rb
+- lib/hash_accessor.rb
+- lib/railtie.rb
+- rails/init.rb
+homepage: 
+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.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: This gem provides extended functionality to serialized hashed in rails. It
+  allows you to define accessor methods for variable that rest inside a serialized
+  hash. This is very useful if you have a large list of often changing DB variables
+  on a model which don't get queried against.
+test_files: []