mschuerig-easy_enums 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-04-02
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/easy_enums.rb
+rails/init.rb
+test/test_easy_enums.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,64 @@
+= easy_enums
+
+* http://github.com/mschuerig/easy_enums
+
+== DESCRIPTION:
+
+Simplistic enumerations for ActiveRecord.
+
+== FEATURES/PROBLEMS:
+
+* Easy access to cached enumerations.
+* Simple/Simplistic.
+* Reloading does not work across server processes.
+  Therefore, only use it for data that is static.
+
+== SYNOPSIS:
+
+  class Color < ActiveRecord::Base
+    enumerates do |e|
+      e.create :name => 'red'
+      e.create :name => 'green'
+      e.create :name => 'blue'
+    end
+  end
+  
+* Color[:green]
+* Color.find_by_name('red')
+* Color.find_by_name!(:red)
+* Color.all
+* Color.count
+* Color.reload
+
+== REQUIREMENTS:
+
+* ActiveRecord
+
+== INSTALL:
+
+* sudo gem install mschuerig-easy_enums
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Michael Schuerig
+
+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,23 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/easy_enums'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('easy_enums', EasyEnumerations::VERSION) do |p|
+  p.developer('Michael Schuerig', 'michael@schuerig.de')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/easy_enums.rb

@@ -0,0 +1,96 @@
+
+module EasyEnumerations
+  VERSION = '0.0.1'
+  
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    def enumerates
+      extend SingletonMethods
+      validates_presence_of :name
+      creator = EnumerationCreator.new(self)
+      yield creator
+      @enum_cache = creator.cache
+    end
+  end
+  
+  module SingletonMethods
+    def all
+      @enum_cache.values
+    end
+    
+    def count(*args)
+      if args.empty?
+        @enum_cache.size
+      else
+        super
+      end
+    end
+    
+    def reload
+      @enum_cache.reload
+    end
+    
+    def find_by_name(name)
+      @enum_cache[name]
+    end
+    alias :[] :find_by_name
+    
+    def find_by_name!(name)
+      find_by_name(name) or
+        raise ::ActiveRecord::RecordNotFound, "Couldn't find #{self.name} with name = #{name}"
+    end
+    
+    def each_name
+      all.each do |role_type|
+        yield role_type.name
+      end
+    end
+  end 
+  
+  class EnumerationCreator
+    def initialize(model)
+      @model = model
+    end
+    
+    def create(options)
+      unless @model.exists?(:name => options[:name])
+        @model.create!(options)
+      end
+    end
+    
+    def cache
+      Cache.new(@model)
+    end
+    
+    private
+
+    class Cache
+      def initialize(model)
+        @model = model
+        reload
+      end
+    
+      def reload
+        @cache = @model.find(:all).inject({}) do |c, e|
+          c[e.name] = e
+          c
+        end
+      end
+      
+      def values
+        @values ||= @cache.values
+      end
+      
+      def [](name)
+        @cache[name.to_s]
+      end
+      
+      def size
+        values.size
+      end
+    end
+  end
+end

data/test/test_easy_enums.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+module ActiveRecord
+  class RecordNotFound < StandardError; end
+end
+
+class TestEasyEnums < Test::Unit::TestCase
+
+  module ActiveRecordMock
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      def validates_presence_of(*args); end
+      def exists?(args); false; end
+      def find(*args); @values; end
+      
+      def create!(options)
+        @values ||= []
+        @values << new(options[:name])
+      end
+    end
+    
+    attr_reader :name
+    def initialize(name)
+      @name = name
+    end
+    
+    def ==(other)
+      name == other.name
+    end
+  end
+  
+  class Enumbed
+    include ActiveRecordMock
+    include EasyEnumerations
+    
+    enumerates do |e|
+      e.create :name => 'red'
+      e.create :name => 'green'
+      e.create :name => 'blue'
+    end
+  end
+  
+  class Season
+    include ActiveRecordMock
+    include EasyEnumerations
+    
+    enumerates do |e|
+      e.create :name => 'Spring'
+      e.create :name => 'Summer'
+      e.create :name => 'Fall'
+      e.create :name => 'Winter'
+    end
+  end
+  
+  def test_array_access
+    assert_equal Enumbed.new('red'), Enumbed[:red]
+    assert_equal Enumbed.new('red'), Enumbed['red']
+    assert_nil Enumbed[:magenta]
+  end
+
+  def test_find_by_name
+    assert_equal Enumbed.new('red'), Enumbed.find_by_name(:red)
+    assert_equal Enumbed.new('red'), Enumbed.find_by_name('red')
+    assert_nil Enumbed.find_by_name(:magenta)
+  end
+
+  def test_find_by_name!
+    assert_raise(ActiveRecord::RecordNotFound) do
+      Enumbed.find_by_name!(:magenta)
+    end
+  end
+  
+  def test_count
+    assert_equal 3, Enumbed.count
+  end
+  
+  def test_all
+    assert_equal ['blue', 'green', 'red'],
+      Enumbed.all.map { |e| e.name }.sort
+  end
+  
+  def test_two_enums_do_not_interfere
+    assert_equal ["Fall", "Spring", "Summer", "Winter"],
+      Season.all.map { |e| e.name }.sort
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/easy_enums'

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: mschuerig-easy_enums
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Schuerig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Simplistic enumerations for ActiveRecord.
+email: 
+- michael@schuerig.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/easy_enums.rb
+- test/test_easy_enums.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mschuerig/easy_enums
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: easy_enums
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simplistic enumerations for ActiveRecord.
+test_files: 
+- test/test_helper.rb
+- test/test_easy_enums.rb