acts-as-optionable 0.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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

@@ -0,0 +1,13 @@
+ActsAsOptionable
+================
+
+I don't recommend using this yet since I'm going to make a couple core changes shortly.  Very alpha.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2010 [name of plugin creator], released under the MIT license

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "acts-as-optionable"
+    gemspec.summary = "ActsAsOptionable is a plugin for Rails that support adding options, as well as specify default options, to ActiveRecord models."
+    gemspec.description = "Add options to ActiveRecord models.  I don't advise using this yet, as it's very alpha."
+    gemspec.email = "xternal1+aao@gmail.com"
+    gemspec.homepage = "http://github.com/bemurphy/acts_as_optionable"
+    gemspec.authors = ["Brendon Murphy"]
+    gemspec.files =  FileList["[A-Z]*", "{lib,spec,rails}/**/*"] - FileList["**/*.log"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc 'Generate documentation for the acts_as_optionable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsOptionable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Default: run specs'
+task :default => :spec
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/acts-as-optionable.rb

@@ -0,0 +1,3 @@
+require "acts_as_optionable/acts_as_optionable"
+require "acts_as_optionable/option_methods"
+require "acts_as_optionable/specify_option"

data/lib/acts_as_optionable/acts_as_optionable.rb

@@ -0,0 +1,72 @@
+module ActiveRecord
+  module Acts
+    module Optionable
+      def self.included(base)
+        base.extend ClassMethods
+      end
+    
+      module ClassMethods
+        def acts_as_optionable
+          has_many :options, :as => :optionable, :dependent => :destroy
+          include IntanceMethods
+          extend ActiveRecord::Acts::Optionable::SpecifyOption::ClassMethods
+          include ActiveRecord::Acts::Optionable::SpecifyOption::InstanceMethods
+        end        
+      end
+    
+      module IntanceMethods
+        def set_option(name, value)
+          option = get_stored_option(name) || options.build(:name => name.to_s)
+          return if new_option_matches_current?(option)
+          option.value = value
+          ret = option.save!
+          options(:reload)
+          ret
+        end
+        
+        def get_option(name)
+          get_stored_option(name) ||
+          get_default_option(name)
+        end
+        
+        def get_default_option(name)
+          instance_specified_option(name) || self.class.get_specified_option(name)
+        end
+        
+        def get_default_options
+          self.class.optionable_specified_options.merge(instance_specified_options || {})
+        end
+        
+        def delete_option(name)
+          if option = options(:reload).find_by_name(name.to_s)
+            option = option.destroy
+            options(:reload)
+            option
+          end
+        end
+        
+        def options_and_defaults
+          options_as_hash = options.inject({}) do |memo, option|
+            memo[option.name.to_s] = option
+            memo
+          end
+          get_default_options.merge(options_as_hash)
+        end
+      
+        def specified_options
+          raise "TODO"
+        end
+        
+        protected
+        
+        def get_stored_option(name)
+          options.detect { |option| option.name.to_s == name.to_s }
+        end
+        
+        def new_option_matches_current?(option)
+          (!option.new_record? && option.value == value) || (get_default_option(name).value == value rescue nil)
+        end
+      end
+    end
+  end  
+end

data/lib/acts_as_optionable/option_methods.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  module Acts
+    module Optionable
+      module OptionMethods        
+        def self.included(option_model)
+          option_model.extend Finders
+        end
+
+        module Finders
+          def find_options_for_optionable(optionable_str, optionable_id)
+            all(:conditions => { :optionable_type => optionable_str, :optionable_id => optionable_id }, :order => "created_at DESC")
+          end
+        end
+      end
+    end
+  end  
+end

data/lib/acts_as_optionable/options_template.rb

@@ -0,0 +1,13 @@
+# module ActiveRecord
+#   module Acts
+#     module Optionable
+#       module SpecifyOption
+#         class OptionsTemplate
+#           def initialize(template_hash = {})
+#             
+#           end
+#         end
+#       end
+#     end
+#   end
+# end

data/lib/acts_as_optionable/specify_option.rb

@@ -0,0 +1,38 @@
+module ActiveRecord
+  module Acts
+    module Optionable
+      module SpecifyOption
+        module ClassMethods
+          def specify_option(option_name, opts = {})
+            optionable_specified_options[option_name.to_s] = Option.new_readonly(:name => option_name.to_s, :default => opts[:default])
+          end
+          
+          def optionable_specified_options
+            @optionable_specified_options ||= {}
+          end
+
+          def get_specified_option(option_name)
+            optionable_specified_options[option_name.to_s]
+          end          
+        end
+
+        module InstanceMethods
+          attr_reader :instance_specified_options
+
+          def instance_specified_option(option_name)
+            instance_specified_options[option_name.to_s] if instance_specified_options
+          end
+
+          def instance_specified_options=(opts)
+            opts.symbolize_keys!
+            @instance_specified_options = {}
+            opts.each do |option_name, attributes|
+              attributes.symbolize_keys!
+              @instance_specified_options[option_name.to_s] = Option.new_readonly(:name => option_name, :default => attributes[:default])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require "acts-as-optionable"
+
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::Optionable)
+
+RAILS_DEFAULT_LOGGER.info "** acts_as_optionable: initialized properly."

data/spec/acts_as_optionable_spec.rb

@@ -0,0 +1,232 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+class Mixin < ActiveRecord::Base
+end
+
+class SpecifiedMixin < Mixin
+  acts_as_optionable
+  
+  specify_option :foo, :default => "FOOFOO"
+  specify_option :bar, :default => "BARBAR"
+end
+
+class NoSpecifiedMixin < Mixin
+  acts_as_optionable
+end
+
+# Don't want output from AR
+$stdout = StringIO.new
+
+def setup_db
+  ActiveRecord::Base.logger
+  ActiveRecord::Schema.define do
+    create_table :mixins do |t|
+      t.string :value
+    end
+    
+    create_table :options do |t|
+      t.string :name
+      t.string :value
+      t.references :optionable, :polymorphic => true
+      t.timestamps
+    end
+    
+  end  
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+describe "ActsAsOptionable" do
+  before(:all) do
+    setup_db
+  end
+  
+  after(:all) do
+    teardown_db
+  end
+  
+  after(:each) do
+    Option.delete_all
+    Mixin.delete_all
+  end
+  
+  before(:each) do
+    @optionable = SpecifiedMixin.create!    
+    @options_template = { :fizz => { :default => "FIZZFIZZ" }, :buzz => { :default => "BUZZBUZZ" } }
+  end
+  
+  describe "specifying options at class level" do
+    it "should have the proper number of options set" do
+      @optionable.get_default_options.length.should == 2
+    end
+    
+    it "should have the expected options set" do
+      @optionable.get_option(:foo).value.should == "FOOFOO"
+      @optionable.get_option(:bar).value.should == "BARBAR"
+    end
+    
+    it "should not mix specifications across unrelated classes" do
+      class Foobar < Mixin
+        acts_as_optionable
+        specify_option :foobar, :default => "FOOBAR"
+      end
+      
+      foobar = Foobar.create!
+      foobar.get_option(:foobar).value.should == "FOOBAR"
+      Foobar.optionable_specified_options.should_not have_key("foo")
+      Foobar.optionable_specified_options.should_not have_key("bar")
+    end
+    
+    it "should return readonly records for the default options" do
+      @optionable.get_option(:foo).should be_readonly
+    end
+  end
+  
+  describe "specifying options at the instance level" do
+    before(:each) do
+      @optionable = NoSpecifiedMixin.create!
+    end
+    
+    it "should allow setting the options" do
+      lambda {
+        @optionable.instance_specified_options = @options_template
+      }.should_not raise_error
+    end
+    
+    it "should have the expected default options" do
+      @optionable.instance_specified_options = @options_template
+      @optionable.get_option(:fizz).value.should == "FIZZFIZZ"
+      @optionable.get_option(:buzz).value.should == "BUZZBUZZ"
+    end
+    
+    it "should return readonly records for the default options" do
+      @optionable.instance_specified_options = @options_template
+      @optionable.get_option(:fizz).should be_readonly
+    end
+  end
+
+  describe "default option precedence" do
+    before(:each) do
+      @optionable.instance_specified_options = @options_template.merge(:bar => {:default => "INSTANCE"}, :fizzbuzz => { :default => "FIZZBUZZ"})
+    end
+
+    it "should use class level defaults if an instance level doesn't exist" do
+      @optionable.get_option(:bar).value.should == "INSTANCE"
+    end
+    
+    it "should use instance level regardless of state of class level default" do
+      @optionable.get_option(:fizzbuzz).value.should == "FIZZBUZZ"
+    end
+    
+    it "should be nil if no default is set" do
+      @optionable.get_option(:bogus).should be_nil
+    end
+  end
+  
+  describe "working with stored options" do
+    before(:each) do
+      @key = :is_something
+    end
+    
+    describe "storing options" do
+      it "should be able to store a number" do
+        @optionable.set_option(@key, 9876)
+        @optionable.get_option(@key).value.should == 9876
+      end
+    
+      it "should be able to store false" do
+        @optionable.set_option(@key, false)
+        @optionable.get_option(@key).value.class.should == FalseClass
+      end
+    
+      it "should be able to store true" do
+        @optionable.set_option(@key, true)
+        @optionable.get_option(@key).value.class.should == TrueClass
+      end
+    
+      it "should be able to store a string" do
+        @optionable.set_option(@key, "a-string")
+        @optionable.get_option(@key).value.should == "a-string"
+      end
+    
+      it "should raise an exception if you try to store an unapproved type" do
+        lambda { @optionable.set_option(@key, {:a => "b"}) }.should raise_error(ArgumentError)
+      end
+    
+      it "should create a new option if one didn't already exist" do
+        @optionable.set_option(@key, true)
+        lambda {@optionable.set_option(:new_option, "new-option") }.should change { Option.count }.by(1)
+      end
+    
+      it "should not insert a new option if it already exists" do
+        @optionable.set_option(@key, true)
+        lambda {@optionable.set_option(@key, false) }.should_not change { Option.count }
+      end
+    
+      it "should overwrite the option if it already exists" do
+        @optionable.set_option(@key, true)
+        @optionable.get_option(@key).value.should be_true
+        @optionable.set_option(@key, false)
+        @optionable.get_option(@key).value.should be_false
+      end
+    end
+    
+    describe "getting options" do
+      it "should prefer the stored option over a default class option" do
+        @optionable.class.optionable_specified_options.should have_key("foo")
+        n = rand(999)
+        @optionable.set_option("foo", n)
+        @optionable.get_option("foo").value.should == n
+      end
+      
+      it "should prefer the stored option over a default instance option" do
+        n = rand(999)
+        @optionable.instance_specified_options = @options_template.merge(:foo => { :default => n })
+        @optionable.get_option("foo").value.should == n
+        j = rand(999)
+        @optionable.set_option("foo", j)
+        @optionable.get_option("foo").value.should == j
+      end
+    end
+    
+    describe "deleting options" do
+      before(:each) do
+        @key = :delete_me
+        @optionable.set_option(@key, "delete-me")
+      end
+      
+      it "should remove a row from the options" do
+        lambda { @optionable.delete_option(@key) }.should change { Option.count }.by(-1)
+      end
+      
+      it "should delete the option" do
+        @optionable.get_option(@key).value.should == "delete-me"
+        @optionable.delete_option(@key)
+        @optionable.get_option(@key).should be_nil
+      end
+      
+      it "should not impact a default class option" do
+        @optionable.get_option("foo").value.should == "FOOFOO"
+        @optionable.set_option("foo", "foofoo")
+        @optionable.get_option("foo").value.should == "foofoo"
+        @optionable.delete_option("foo")
+        @optionable.get_option("foo").value.should == "FOOFOO"
+      end
+      
+      it "should not impact a default instance option" do
+        @optionable.instance_specified_options = @options_template
+        @optionable.get_option("fizz").value.should == "FIZZFIZZ"
+        @optionable.set_option("fizz", "fizzfizz")
+        @optionable.get_option("fizz").value.should == "fizzfizz"
+        @optionable.delete_option("fizz")
+        @optionable.get_option("fizz").value.should == "FIZZFIZZ"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+rescue LoadError
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+plugin_spec_dir = File.dirname(__FILE__)
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: acts-as-optionable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Add options to ActiveRecord models.  I don't advise using this yet, as it's very alpha.
+email: xternal1+aao@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/acts-as-optionable.rb
+- lib/acts_as_optionable/acts_as_optionable.rb
+- lib/acts_as_optionable/option_methods.rb
+- lib/acts_as_optionable/options_template.rb
+- lib/acts_as_optionable/specify_option.rb
+- rails/init.rb
+- spec/acts_as_optionable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bemurphy/acts_as_optionable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: ActsAsOptionable is a plugin for Rails that support adding options, as well as specify default options, to ActiveRecord models.
+test_files: 
+- spec/acts_as_optionable_spec.rb
+- spec/spec_helper.rb