easy_class_constants 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nina R.
+
+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,53 @@
+# EasyClassConstants
+
+Gem adds class methods to create readable, writable and accessible constants.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_class_constants'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_class_constants
+
+## Usage
+
+Adding constants to your class is easy:
+
+    class ECCObject
+      include EasyClassConstants
+  
+      readable_constant :read_only, 'R'
+      writable_constant :write_only, 'W'
+      accessible_constant :read_write, 'RW'
+      hash_indexed_by_readable_constants(:mapping, [[:internal_error, 0, 'Internal Error - Try Again Later'],
+                                              [:network_error, 1, 'Network Error - Check With Your Admin']])
+
+      hash_indexed_by_readable_constants(:simple_mapping, [[:HELLO_WORLD, 'Hello World'],
+                                              [:HELLO_KITTY, 'Hello Kitty']])
+                                      
+    end
+    
+Then you can call:
+
+    ECCTestObject.INTERNAL_ERROR                 #will return 0
+    ECCTestObject.SIMPLE_MAPPING[:HELLO_KITTY]   # will return 'Hello Kitty'
+    ECCTestObject.SIMPLE_MAPPING.HELLO_KITTY     # will return 'Hello Kitty'
+    ECCTestObject.READ_WRITE                     # will return 'RW'
+
+
+# Credits
+
+[Oha_extensions](https://github.com/bkr/oha_extensions) is maintained by [Bookrenter/Rafter](http://github.com/bkr) and is funded by [BookRenter.com](http://www.bookrenter.com "BookRenter.com").
+
+![BookRenter.com Logo](http://assets0.bookrenter.com/images/header/bookrenter_logo.gif "BookRenter.com")
+
+# Copyright
+
+Copyright (c) 2012 Bookrenter.com. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/easy_class_constants.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/easy_class_constants/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bookrenter/Rafter"]
+  gem.email         = ["cp@bookrenter.com"]
+  gem.description   = %q{Gem adds class methods to create readable, writable and accessible constants.}
+  gem.summary       = %q{Gem adds class methods to create readable, writable and accessible constants.}
+  gem.homepage      = "https://github.com/bkr/easy_class_constants"
+  
+  gem.add_dependency('rails', '> 0')
+  gem.add_development_dependency('mocha', '> 0')
+  gem.add_development_dependency('shoulda', "> 0")
+
+  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          = "easy_class_constants"
+  gem.require_paths = ["lib"]
+  gem.version       = EasyClassConstants::VERSION
+end

data/lib/easy_class_constants.rb

@@ -0,0 +1,54 @@
+require "easy_class_constants/version"
+
+module EasyClassConstants
+  
+  def self.included(receiver)
+    receiver.extend ClassMethods
+  end
+  
+  module ClassMethods
+    def readable_constant(name, value)
+      name = name.to_s.upcase
+      self.send(:class_variable_set, "@@#{name}", value)
+      self.send(:cattr_reader, name)
+    end
+
+    def writable_constant(name, value)
+      name = name.to_s.upcase
+      self.send(:class_variable_set, "@@#{name}", value)
+      self.send(:cattr_writer, name)
+    end
+
+    def accessible_constant(name, value)
+      name = name.to_s.upcase
+      self.send(:class_variable_set, "@@#{name}", value)
+      self.send(:cattr_accessor, name)
+    end
+
+    def hash_indexed_by_readable_constants(hash_variable_name, hash_contents)
+      hash_variable_name = hash_variable_name.to_s.upcase
+      self.send(:class_variable_set, "@@#{hash_variable_name}", ActiveSupport::OrderedHash.new)
+      self.send(:cattr_reader, hash_variable_name)
+      hash_contents.each do |*args|
+        args.flatten!
+        constant_name = args[0].to_s.upcase
+
+        if args.size > 2
+          hash_index = args[1]
+          hash_value = args[2]
+          variable_value = hash_index
+        else
+          hash_index = args[0]
+          hash_value = args[1]
+          variable_value = hash_value
+        end
+
+
+        puts "WARNING: in .hash_indexed_by_readable_constants. Constant is already defined: #{constant_name}" if (self.send(:class_variable_get, "@@#{constant_name}").present? rescue false)
+        self.send(:class_variable_set, "@@#{constant_name}", variable_value)
+        self.send(:class_variable_get, "@@#{hash_variable_name}")[hash_index] = hash_value
+        self.send(:cattr_reader, constant_name)
+      end
+    end
+  end
+end

data/lib/easy_class_constants/version.rb

@@ -0,0 +1,3 @@
+module EasyClassConstants
+  VERSION = "0.0.1"
+end

data/test/easy_class_constants_test.rb

@@ -0,0 +1,75 @@
+require "test_helper"
+
+class EasyClassConstantsTest < Test::Unit::TestCase
+  class ECCTestObject
+    include EasyClassConstants
+    
+    readable_constant :read_only, 'R'
+    writable_constant :write_only, 'W'
+    accessible_constant :read_write, 'RW'
+    hash_indexed_by_readable_constants(:mapping, [[:internal_error, 0, 'Internal Error - Try Again Later'],
+                                            [:network_error, 1, 'Network Error - Check With Your Admin']])
+
+    hash_indexed_by_readable_constants(:simple_mapping, [[:HELLO_WORLD, 'Hello World'],
+                                            [:HELLO_KITTY, 'Hello Kitty']])
+                                        
+  end
+  
+  context "hash_indexed_by_readable_constants" do
+    context "with 3 arg mapping" do
+      should "create readable constant from created hash" do
+        assert_equal 'Internal Error - Try Again Later', ECCTestObject.MAPPING[0]
+        assert_equal 'Network Error - Check With Your Admin', ECCTestObject.MAPPING[1]
+      end
+
+      should "create constants for each constant name" do
+        assert_equal 0, ECCTestObject.INTERNAL_ERROR
+        assert_equal 1, ECCTestObject.NETWORK_ERROR
+      end      
+    end
+    
+    context "with 2 arg mapping" do
+      should "create readable constant from created hash" do
+        assert_equal 'Hello World', ECCTestObject.SIMPLE_MAPPING[:HELLO_WORLD]
+        assert_equal 'Hello Kitty', ECCTestObject.SIMPLE_MAPPING[:HELLO_KITTY]
+      end
+      
+      should "create constants for each constant name" do
+        assert_equal 'Hello World', ECCTestObject.HELLO_WORLD
+        assert_equal 'Hello Kitty', ECCTestObject.HELLO_KITTY
+      end
+    end
+  end
+  
+  context "readable_constant" do
+    should "be readable" do
+      assert_equal 'R', ECCTestObject.READ_ONLY
+    end
+    
+    should "not be writeable" do
+      assert_raise(NoMethodError) { ECCTestObject.READ_ONLY = 1 }
+    end
+  end
+  
+  context "writable_constant" do
+    should "not be readable" do
+      assert_raise(NoMethodError) { ECCTestObject.WRITE_ONLY }
+    end
+    
+    should "be writeable" do
+      ECCTestObject.WRITE_ONLY = 1
+      assert_equal 1, ECCTestObject.send(:class_variable_get, '@@WRITE_ONLY')
+    end  
+  end
+  
+  context "accessible_constant" do
+    should "be readable" do
+      assert_equal 'RW', ECCTestObject.READ_WRITE
+    end
+
+    should "be writeable" do
+      ECCTestObject.READ_WRITE = 1
+      assert_equal 1, ECCTestObject.READ_WRITE
+    end    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'rails'
+
+require File.dirname(__FILE__) + '/../lib/easy_class_constants'
+
+require 'easy_class_constants'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: easy_class_constants
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bookrenter/Rafter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: Gem adds class methods to create readable, writable and accessible constants.
+email:
+- cp@bookrenter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- easy_class_constants.gemspec
+- lib/easy_class_constants.rb
+- lib/easy_class_constants/version.rb
+- test/easy_class_constants_test.rb
+- test/test_helper.rb
+homepage: https://github.com/bkr/easy_class_constants
+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: Gem adds class methods to create readable, writable and accessible constants.
+test_files:
+- test/easy_class_constants_test.rb
+- test/test_helper.rb