bits2life-rails_utils 0.0.1

data/MIT-LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Erik Hansson
+
+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,18 @@
+= Rails Utils
+
+This is just a collection of utility classes and adaptations for Rails that I've come
+to use on occasion. I've been torn between bunching them up or releasing them in 
+smaller packages, but came to the realization that I'd better not put a gazillion 
+12-line gems out there. My sanity will break first.
+
+== Installation
+
+Install like a rails plugin, either by:
+
+  script/plugin install git://github.com/bits2life/rails_utils.git
+  
+... or load the gem in your environment.rb:
+
+  config.gem 'bits2life-rails_utils', :source => "http://gems.github.com", :lib => "rails_utils"
+
+If you choose the latter, also make sure you install the gem.

data/lib/rails_utils.rb

@@ -0,0 +1 @@
+require 'rails_utils/ordinal.rb'

data/lib/rails_utils/ordinal.rb

@@ -0,0 +1,57 @@
+
+module RailsUtils
+
+  class OrdinalValue
+    include Comparable
+
+    def initialize(possible_values, value)
+      @possible_values = possible_values
+      set value
+    end
+    
+    def set(value)
+      @value = @possible_values.index value.to_sym
+    end
+
+    def <=>(other)
+      @value <=> @possible_values.index(other.to_sym)
+    end
+
+    def to_s; @possible_values[@value].to_s; end
+    def to_sym; @possible_values[@value]; end
+  end
+  
+  
+  module ActiveRecord
+    module BaseExtensions
+      
+      def ordinal_field(field_name, options = {})
+        define_method "#{field_name}" do
+          s = instance_variable_get "@#{field_name}_status"
+          if s.nil?
+            s = OrdinalValue.new options[:values], (self[field_name] || options[:default])
+            instance_variable_set "@#{field_name}_status", s
+          end
+          s
+        end
+
+        define_method "#{field_name}=" do |value|
+          s = self.send(field_name)
+          s.set value
+          self[field_name] = s.to_s
+          s
+        end
+      end
+      
+      def ordinal_fields(*args)
+        options = (Hash === args[-1]) ? args.pop : {}
+        
+        args.each do |field_name|
+          ordinal_field field_name, options
+        end
+      end
+      
+    end
+  end
+  
+end

data/lib/rails_utils/version.rb

@@ -0,0 +1,9 @@
+module RailsUtils #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+class ActiveRecord::Base
+  extend RailsUtils::ActiveRecord::BaseExtensions
+end

data/spec/ordinal_spec.rb

@@ -0,0 +1,42 @@
+$:.push File.dirname(__FILE__) + "/../lib"
+require File.dirname(__FILE__) + "/../init.rb"
+
+
+describe "Ordinal" do
+  
+  class MockUser
+    extend RailsUtils::ActiveRecord::BaseExtensions
+    
+    ordinal_field :guild_access, :values => [:none, :member, :officer, :guildmaster], :default => :none
+    
+    def [](key); instance_variable_get("@#{key.to_s}"); end
+    def []=(key, value); instance_variable_set("@#{key.to_s}", value); end
+  end
+  
+  
+  before(:each) do
+    @user = MockUser.new
+    @user.guild_access = :member
+  end
+  
+  it "should be comparable against known access levels" do
+    @user.guild_access.should >= :none
+    @user.guild_access.should >= :member
+    @user.guild_access.should_not >= :officer
+    @user.guild_access.should_not >= :guildmaster
+  end
+  
+  it "should raise an error if compared with unknown access level" do
+    lambda do
+      @user.guild_access.should >= :foobar
+    end.should raise_error
+  end
+
+
+  it "should be able to provide a default value" do
+    @user = MockUser.new
+    @user.guild_access.should >= :none
+    @user.guild_access.should_not >= :member
+  end
+  
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: bits2life-rails_utils
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Erik Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: erik@bits2life.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENCE
+- README
+- lib/rails_utils/ordinal.rb
+- lib/rails_utils/version.rb
+- lib/rails_utils.rb
+- rails/init.rb
+- spec/ordinal_spec.rb
+has_rdoc: true
+homepage: http://github.com/bits2life/rails_utils
+post_install_message: 
+rdoc_options: 
+- --title
+- RailsUtils
+- --main
+- README
+- README
+- lib
+- spec
+- --line-numbers
+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.2.0
+signing_key: 
+specification_version: 2
+summary: A number of small rails utilities and adaptations.
+test_files: []
+