simple_enumerations 0.1.1

data/LICENSE

@@ -0,0 +1,9 @@
+(The MIT License)
+
+Copyright (c) 2009 Mariusz Pietrzyk (wijet at wijet dot pl)
+
+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.markdown

@@ -0,0 +1,69 @@
+Simple Enumerations
+==================
+
+Provides simple and clean enumerations system for rails apps.
+Enumerations are defined in one file and stored in the database, as strings.
+
+Installation
+============
+
+    script/plugin install git://github.com/wijet/simple_enumerations.git
+
+Usage
+=====
+
+    # config/enumerations.yml
+    policy:
+      - open
+      - closed
+      - by approval
+
+    # app/models/group.rb
+    class Group < ActiveRecord::Base
+      has_enumerated :policy
+    end
+
+You can generate sample enumerations file by running 
+
+    script/generate enumerations
+
+Plugin generates following methods:
+
+    @group.policy.open?
+    @group.policy.closed?
+    @group.policy.by_approval?
+    
+Fetching enumerations 
+
+    Enumeration[:policy] # => ['open', 'closed', 'by approval']
+    Enumeration.all # => {'policy' => ['open', 'closed', 'by approval']}
+    
+Using enumeration in case statements is very easy
+
+    case @group.policy
+      when :open then ...
+      when :closed then ...
+      when :by_approval then ...
+    end
+
+Plugin includes helper for creating select boxes
+
+    f.select_enumeration :policy
+
+REQUIREMENTS
+============
+
+rails >= 2.1
+
+LICENSE
+=======
+
+(The MIT License)
+
+Copyright (c) 2009 Mariusz Pietrzyk (wijet at wijet dot pl)
+
+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/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "simple_enumerations"
+    gem.summary = %Q{Simple enumerations system for rails apps}
+    gem.description = %Q{Provides simple and clean enumerations system for rails apps. Enumerations are defined in one file and stored in the database, as strings.}
+    gem.email = "wijet@wijet.pl"
+    gem.homepage = "http://github.com/wijet/simple_enumerations"
+    gem.authors = ["Mariusz Pietrzyk"]
+    gem.add_development_dependency "rspec"
+#    gem.files.include FileList['lib/**/*.rb', 'rails/init.rb']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_enumerations #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 1

data/generators/enumerations/enumerations_generator.rb

@@ -0,0 +1,7 @@
+class EnumerationsGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file 'enumerations.yml', "config/enumerations.yml"
+    end
+  end
+end

data/generators/enumerations/templates/enumerations.yml

@@ -0,0 +1,5 @@
+# Here define your enumerations
+#enumeration_name:
+#  - value1
+#  - value2
+#  - value3

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/rails/init.rb'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/simple_enumerations.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../rails/init.rb'

data/lib/simple_enumerations/form_helper.rb

@@ -0,0 +1,8 @@
+module Wijet  
+  module FormHelper
+    def select_enumeration(method)
+      @template.select_tag "#{@object_name}[#{method}]",
+        @template.options_from_collection_for_select(Enumeration[method], :to_s, :to_s , @object.send(method).to_s)
+    end
+  end
+end

data/lib/simple_enumerations/simple_enumerations.rb

@@ -0,0 +1,56 @@
+module Wijet
+  module SimpleEnumerations
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def has_enumerated(name)
+        name = name.to_s
+        
+        define_method("#{name}=") do |value|
+          value = value.to_s
+          unless Enumeration[name].include?(value) or value.blank?
+            raise ArgumentError, "'#{value}' is not a value of enumeration '#{name}'" 
+          end
+          write_attribute(name, value)
+        end
+        
+        define_method(name) do
+          EnumerationString::Enumeration.new(attributes[name])
+        end
+      end
+    end
+    
+    module EnumerationString
+      class Enumeration < String
+        def initialize(value = "")
+          super(value)
+        end
+        
+        class << self
+          def [](name)
+            raise ArgumentError, "Enumeration '#{name}' doesn't exist" unless all.has_key?(name.to_s)
+            all[name.to_s]
+          end
+      
+          def all
+            Rails.cache.fetch('_simple_enumerations_') do
+              YAML::load(File.read(File.join(RAILS_ROOT, 'config', 'enumerations.yml')))
+            end
+          end
+        end
+      
+        all.values.flatten.uniq.each do |value|
+          define_method("#{value.gsub(/[^[:alnum:]]/, '_')}?") { self == value }
+        end unless all.blank?
+
+        def ===(object)
+          self == object.to_s
+        end
+      end
+    end
+  end
+end
+
+include Wijet::SimpleEnumerations::EnumerationString

data/lib/simple_enumerations/symbol_extension.rb

@@ -0,0 +1,5 @@
+class Symbol
+  def ===(object)
+    object.kind_of?(Enumeration) ? object === self : super
+  end
+end

data/rails/init.rb

@@ -0,0 +1,7 @@
+if File.exists?(File.join(RAILS_ROOT, 'config', 'enumerations.yml'))
+  require 'simple_enumerations/simple_enumerations'
+  require 'simple_enumerations/symbol_extension'
+  require 'simple_enumerations/form_helper'
+  ActiveRecord::Base.send(:include, Wijet::SimpleEnumerations)
+  ActionView::Helpers::FormBuilder.send(:include, Wijet::FormHelper)
+end

data/simple_enumerations.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple_enumerations}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mariusz Pietrzyk"]
+  s.date = %q{2009-10-15}
+  s.description = %q{Provides simple and clean enumerations system for rails apps. Enumerations are defined in one file and stored in the database, as strings.}
+  s.email = %q{wijet@wijet.pl}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION.yml",
+     "generators/enumerations/enumerations_generator.rb",
+     "generators/enumerations/templates/enumerations.yml",
+     "init.rb",
+     "install.rb",
+     "lib/simple_enumerations.rb",
+     "lib/simple_enumerations/form_helper.rb",
+     "lib/simple_enumerations/simple_enumerations.rb",
+     "lib/simple_enumerations/symbol_extension.rb",
+     "rails/init.rb",
+     "simple_enumerations.gemspec",
+     "spec/app_root/app/models/group.rb",
+     "spec/app_root/app/views/cars/new.html.erb",
+     "spec/app_root/config/enumerations.yml",
+     "spec/app_root/db/schema.rb",
+     "spec/form_helper_spec.rb",
+     "spec/simple_enumerations_spec.rb",
+     "spec/spec_helper.rb",
+     "tasks/simple_enumerations_tasks.rake",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/wijet/simple_enumerations}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple enumerations system for rails apps}
+  s.test_files = [
+    "spec/app_root/app/models/group.rb",
+     "spec/app_root/db/schema.rb",
+     "spec/form_helper_spec.rb",
+     "spec/simple_enumerations_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/spec/app_root/app/models/group.rb

@@ -0,0 +1,3 @@
+class Group < ActiveRecord::Base
+  has_enumerated :policy
+end

data/spec/app_root/app/views/cars/new.html.erb

@@ -0,0 +1,3 @@
+<% form_for(@car) do |f| %>
+  <%= f.select_enumeration :color %>
+<% end %>

data/spec/app_root/config/enumerations.yml

@@ -0,0 +1,11 @@
+policy:
+  - open
+  - closed
+  - secret
+color:
+  - red
+  - green
+  - blue
+  - yellow
+  - light green
+  

data/spec/app_root/db/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :groups, :force => true do |t|
+    t.string :policy
+  end
+
+  create_table :cars, :force => true do |t|
+    t.string :color
+  end
+  
+  %w(open closed closed secret).each { |policy| Group.create(:policy => policy) }
+  
+  %w(red green).each { |color| execute("INSERT INTO cars(color) VALUES('#{color}')") }
+end

data/spec/form_helper_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/app_root/app/models/group.rb'
+
+describe Wijet::FormHelper do
+  include Wijet::FormHelper
+  include ActionView::Helpers
+  
+  before do
+    stub!(:protect_against_forgery?).and_return(false)
+    stub!(:output_buffer).and_return('')
+    @group = mock_model(Group, :policy => nil)
+  end
+  
+  it "should generate selectbox for enumeration" do
+    render_select.should == '<select id="group_policy" name="group[policy]"><option value="open">open</option>
+<option value="closed">closed</option>
+<option value="secret">secret</option></select>'
+  end
+  
+  it "should generate selectbox for enumeration with selected value" do
+    @group = mock_model(Group, :policy => :open)
+    render_select.should == '<select id="group_policy" name="group[policy]"><option value="open" selected="selected">open</option>
+<option value="closed">closed</option>
+<option value="secret">secret</option></select>'
+  end
+end
+
+def render_select  
+  returning "" do |select|
+    form_for @group, :url => "/groups" do |f| 
+      select << f.select_enumeration(:policy)
+    end
+  end
+end

data/spec/simple_enumerations_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include Wijet::SimpleEnumerations::EnumerationString
+
+describe Enumeration do
+  before :all do
+    @policies = %w(open closed secret)
+    @colors = ['red', 'green', 'blue', 'yellow', 'light green']
+  end
+  
+  describe "class methods" do
+    it "should respond to :all and return all enumerations" do
+      Enumeration.all.should == {'policy' => @policies, 'color' => @colors}
+    end
+  
+    it "should respond to :[] and return requested enumeration" do
+      Enumeration[:policy].should == @policies
+      Enumeration['color'].should == @colors
+    end
+    
+    it "should respond to :[] and raise ArgumentError when requested enumeration doesn't exist" do
+      lambda {
+        Enumeration[:fooooo]
+      }.should raise_error(ArgumentError)
+    end
+    
+    describe "generating instance methods" do
+      it "should generate instance methods, named in format '#\{value\}?'" do
+        (@policies + @colors).each do |value|
+          Enumeration.new.should respond_to("#{value.gsub(/[^[:alnum:]]/, '_')}?")
+        end
+      end
+
+      it "should replace non-alphanumeric characters with underscore" do
+        Enumeration.new.should respond_to(:light_green?)
+      end      
+    end
+  end
+  
+  describe "generated instance methods" do
+    it "should return true if enumeration has particular value" do
+      enum = Enumeration.new('red')
+
+      enum.should be_red # calls enum.red?
+      enum.should_not be_light_green
+      enum.should_not be_open
+    end
+  end
+end
+
+describe Wijet::SimpleEnumerations::ClassMethods do
+  describe "has_enumerated" do
+    before do
+      @group = Group.new(:policy => :open)
+    end
+    
+    it "should generate reader methods which return Enumeration object" do
+      @group.policy.should == 'open'
+      @group.policy.should be_a(Enumeration)
+    end
+    
+    it "should generate writer methods which assign enumeration value" do
+      @group.policy = :open
+      @group.policy.should == Enumeration.new('open')
+    end
+    
+    it "should raise ArgumentError when assigning non-enumeration value" do
+      lambda {
+        @group.policy = :foooooo
+      }.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+
+rescue LoadError
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+Spec::Runner.configure do |config|
+  config.before(:all) do
+    path = [File.dirname(__FILE__), 'app_root', 'config', 'enumerations.yml'] * '/'
+    File.stub!(:join).and_return(path)
+    load File.dirname(__FILE__) + '/../lib/simple_enumerations/simple_enumerations.rb'
+    Rails.cache.delete('_simple_enumerations_')
+  end
+end
+
+require File.dirname(__FILE__) + '/app_root/app/models/group.rb'
+require File.dirname(__FILE__) + '/app_root/db/schema.rb'
+
+plugin_spec_dir = File.dirname(__FILE__)
+

data/tasks/simple_enumerations_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :simple_enumerations do
+#   # Task goes here
+# end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: simple_enumerations
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Mariusz Pietrzyk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-15 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Provides simple and clean enumerations system for rails apps. Enumerations are defined in one file and stored in the database, as strings.
+email: wijet@wijet.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION.yml
+- generators/enumerations/enumerations_generator.rb
+- generators/enumerations/templates/enumerations.yml
+- init.rb
+- install.rb
+- lib/simple_enumerations.rb
+- lib/simple_enumerations/form_helper.rb
+- lib/simple_enumerations/simple_enumerations.rb
+- lib/simple_enumerations/symbol_extension.rb
+- rails/init.rb
+- simple_enumerations.gemspec
+- spec/app_root/app/models/group.rb
+- spec/app_root/app/views/cars/new.html.erb
+- spec/app_root/config/enumerations.yml
+- spec/app_root/db/schema.rb
+- spec/form_helper_spec.rb
+- spec/simple_enumerations_spec.rb
+- spec/spec_helper.rb
+- tasks/simple_enumerations_tasks.rake
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/wijet/simple_enumerations
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple enumerations system for rails apps
+test_files: 
+- spec/app_root/app/models/group.rb
+- spec/app_root/db/schema.rb
+- spec/form_helper_spec.rb
+- spec/simple_enumerations_spec.rb
+- spec/spec_helper.rb