activerecord-enumerated_model 0.1.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test.sqlite3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-enumerated_model.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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.md

@@ -0,0 +1,67 @@
+# ActiveRecord::EnumeratedModel
+
+ActiveRecord::EnumeratedModel is an ActiveRecord extensions that allows
+you to create enumerated constants out of a model containing static
+data.
+
+Sometimes you have a model where values will not change. Consider the
+following:
+
+```ruby
+    class Role
+      ADMIN = 1
+      EDITOR = 2
+      VIEWER = 3
+    end
+```
+
+We'll often do something like this in order to easily check values in
+our application.
+
+```ruby
+    unless @current_user.has?(Role::ADMIN)
+      # some admin stuff
+    end
+```
+
+Keeping this out of ActiveRecord prevents us from doing any kind of
+joining in the database and limits what `Role` can do. Wouldn't be cool
+if you could `Role::ADMIN` returned an ActiveRecord row?
+
+    Role::ADMIN == #<Role name: "Admin">
+
+This is what ActiveRecord::EnumeratedModel provides. Since we're dealing
+with constants here, ActiveRecord::EnumeratedModel also makes your model
+readonly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-enumerated_model'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-enumerated_model
+
+## Usage
+
+Simply include `ActiveRecord::EnumeratedModel` in your model:
+
+```ruby
+    class StaticThing < ActiveRecord::Base
+      include ActiveRecord::EnumeratedModel
+    end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/activerecord-enumerated_model.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/active_record-enumerated_model/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Christian Dinger"]
+  gem.email         = ["cdinger@gmail.com"]
+  gem.description   = %q{Creates an enumeration of constants that contain ActiveRecord rows for a static model}
+  gem.summary       = %q{Creates an enumeration of constants that contain ActiveRecord rows for a static model}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "activerecord-enumerated_model"
+  gem.require_paths = ["lib"]
+  gem.version       = ActiveRecord::EnumeratedModel::VERSION
+
+  gem.add_dependency('activerecord', '>= 3.0.0')
+  gem.add_dependency('activerecord-readonly_model', '>= 0.0.1')
+
+  gem.add_development_dependency('sqlite3')
+  gem.add_development_dependency('shoulda')
+end

data/lib/active_record-enumerated_model.rb

@@ -0,0 +1,5 @@
+require 'active_support/core_ext'
+require 'active_record'
+require 'active_record-readonly_model'
+require 'active_record-enumerated_model/version'
+require 'active_record-enumerated_model/enumerated_model'

data/lib/active_record-enumerated_model/enumerated_model.rb

@@ -0,0 +1,74 @@
+module ActiveRecord
+  module EnumeratedModel
+    class UnknownAttributeError < StandardError; end
+    class NilConstantError < StandardError; end
+
+    module ClassMethods
+
+      def create_enumeration_constants(enumeration_attribute = :name, options = {:force => false})
+        @enumeration_attribute = enumeration_attribute
+        @enumerated_constants = [] if @enumerated_constants.blank?
+        clear_existing_constants if options[:force]
+        attribute = enumeration_attribute.to_s
+
+        self.all.each do |instance|
+          unless instance.attributes.include?(attribute)
+            raise UnknownAttributeError.new("Tried to create constants on the #{attribute} attribute, but it doesn't exist on this model")
+          end
+          value = instance.attributes[attribute]
+          if value.blank?
+            raise NilConstantError.new("Encountered a nil value on the #{attribute} attribute and can't create a constant")
+          end
+          const = ActiveRecord::EnumeratedModel.constant_friendly_string(value)
+          if self.const_defined?(const)
+            if options[:force]
+              self.send(:remove_const, const)
+            else
+              raise RuntimeError.new("Constant #{self.to_s}::#{const} has already been defined")
+            end
+          end
+          self.const_set(const, instance)
+          @enumerated_constants << const
+        end
+      end
+
+      def clear_existing_constants
+        unless @enumerated_constants.blank?
+          @enumerated_constants.each do |existing_constant|
+            if self.const_defined?(existing_constant)
+              self.send(:remove_const, existing_constant)
+            end
+          end
+        end
+      end
+
+      def bypass_readonly(&block)
+        ActiveRecord::ReadonlyModel.bypass do
+          yield
+        end
+        # regenerate constants
+        create_enumeration_constants(@enumeration_attribute, :force => true)
+      end
+    end
+
+    def self.included(caller)
+      caller.extend(ClassMethods)
+      caller.send(:include, ActiveRecord::ReadonlyModel)
+      if caller.attribute_names.include? 'name'
+        caller.create_enumeration_constants :name
+      end
+    end
+
+    def self.constant_friendly_string(str)
+      const = str.upcase
+      const.gsub!(/\s+/, '_')       # replace whitespace with an underscore
+      const.gsub!(/^[^A-Z]+/, '')   # remove leading numbers, symbols, etc
+      const.gsub!(/[-\/\\]/, '_')   # turn these symbols into underscores
+      const.gsub!(/[^A-Z_]/, '')    # remove anything that's not a letter or underscore
+      const.gsub!(/_+/, '_')        # collapse multiple adjacent underscores
+      const.gsub!(/[^A-Z0-9]$/, '') # always end with a non-symbol
+      const
+    end
+
+  end
+end

data/lib/active_record-enumerated_model/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module EnumeratedModel
+    VERSION = "0.1.2"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'active_record'
+require 'active_record-enumerated_model'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => 'test.sqlite3')

data/test/test_bypass.rb

@@ -0,0 +1,43 @@
+require 'helper'
+
+class TestBypass < Test::Unit::TestCase
+  context "Some static model" do
+    setup do
+      ActiveRecord::Base.connection.create_table :static_things, :force => true do |t|
+        t.string :name
+      end
+      ActiveRecord::Base.connection.execute("insert into static_things (name) values ('asdf')")
+      class StaticThing < ActiveRecord::Base
+        include ActiveRecord::EnumeratedModel
+      end
+    end
+
+    teardown do
+      ActiveRecord::Base.connection.drop_table :static_things
+    end
+
+    should "bypass readonly to destroy" do
+      before_count = StaticThing.count
+      StaticThing.bypass_readonly do
+        t = StaticThing.first
+        t.destroy
+      end
+      assert_not_equal(before_count, StaticThing.count)
+    end
+
+    should "bypass readonly to update" do
+      StaticThing.bypass_readonly do
+        thing = StaticThing.first
+        thing.name = 'lkjasdflkjasdf'
+        assert(thing.save)
+      end
+    end
+
+    should "reload constants after bypass" do
+      StaticThing.bypass_readonly do
+        StaticThing.create(:name => 'new thing')
+      end
+      assert(StaticThing::NEW_THING)
+    end
+  end
+end

data/test/test_enumeration.rb

@@ -0,0 +1,60 @@
+require 'helper'
+
+class TestEnumeration < Test::Unit::TestCase
+  context "Some static model" do
+    setup do
+      ActiveRecord::Base.connection.create_table :static_things, :force => true do |t|
+        t.string :name
+      end
+      ActiveRecord::Base.connection.execute("insert into static_things (name) values ('Blah thing')")
+      ActiveRecord::Base.connection.execute("insert into static_things (name) values ('''nother blah\" thing. !')")
+      class StaticThing < ActiveRecord::Base
+        include ActiveRecord::EnumeratedModel
+      end
+    end
+
+    teardown do
+      ActiveRecord::Base.connection.drop_table :static_things
+    end
+
+    should "create constants" do
+      assert(ActiveRecord::EnumeratedModel)
+      assert_equal(StaticThing::BLAH_THING, StaticThing.first)
+      assert_equal(StaticThing::NOTHER_BLAH_THING, StaticThing.last)
+    end
+  end
+
+  context "Some static model without a name attribute" do
+    setup do
+      ActiveRecord::Base.connection.create_table :static_thingies, :force => true do |t|
+        t.string :blah
+      end
+      ActiveRecord::Base.connection.execute("insert into static_thingies (blah) values ('ahoy hoy')")
+      class StaticThingy < ActiveRecord::Base
+        include ActiveRecord::EnumeratedModel
+        create_enumeration_constants :blah
+      end
+    end
+
+    teardown do
+      ActiveRecord::Base.connection.drop_table :static_thingies
+    end
+
+    should "create constants" do
+      assert(ActiveRecord::EnumeratedModel)
+      assert_equal(StaticThingy::AHOY_HOY, StaticThingy.first)
+    end
+  end
+
+  context "constant_friendly_string method" do
+    should "properly format a string for use as a constant" do
+      assert_equal("SOME_CONSTANT", ActiveRecord::EnumeratedModel.constant_friendly_string('Some constant'))
+      assert_equal("THIS_THAT", ActiveRecord::EnumeratedModel.constant_friendly_string('this/that'))
+      assert_equal("BLAH", ActiveRecord::EnumeratedModel.constant_friendly_string('123blah'))
+      assert_equal("BLAH", ActiveRecord::EnumeratedModel.constant_friendly_string('___123blah'))
+      assert_equal("BLAH", ActiveRecord::EnumeratedModel.constant_friendly_string('blah!!!'))
+      assert_equal("BLAH_BLAH", ActiveRecord::EnumeratedModel.constant_friendly_string('blah   blah'))
+      assert_equal("THIS_THAT_THE_OTHER", ActiveRecord::EnumeratedModel.constant_friendly_string('This, that, & the other.'))
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-enumerated_model
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Christian Dinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord-readonly_model
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Creates an enumeration of constants that contain ActiveRecord rows for
+  a static model
+email:
+- cdinger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord-enumerated_model.gemspec
+- lib/active_record-enumerated_model.rb
+- lib/active_record-enumerated_model/enumerated_model.rb
+- lib/active_record-enumerated_model/version.rb
+- test/helper.rb
+- test/test_bypass.rb
+- test/test_enumeration.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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Creates an enumeration of constants that contain ActiveRecord rows for a
+  static model
+test_files:
+- test/helper.rb
+- test/test_bypass.rb
+- test/test_enumeration.rb