rubyenum 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59018f7aa26b4d793b4734b2ba14b92791a4dead
-  data.tar.gz: fb035eefd79d94100f32e79f92545e44e99d3e6c
+  metadata.gz: 9c8c35f0eefaea3a69f72e056fa555a9b1179902
+  data.tar.gz: 8371b1ce5445c3f3878a6860a21d0955e5392b57
 SHA512:
-  metadata.gz: c86272331b68ea897d66e50c280be1dfd598e37d7498e98ea1ae677ad73fbb1baa24a2706dccad658b0f492f4490a4d680cc5c863bcae4b3485542523c6ce8a5
-  data.tar.gz: b8b57468287d3aaee0a2781d53b7ebf7833702f4b5d790334b923e6b6109524529f3e98a3d751357fa16be0124ba4351b687ae140b89acca1587a18902d1a449
+  metadata.gz: 32fdc4390bf0280cf4cee4df923f8dd83555a3f8f5d3c5c683cef824862cd2370953faaeb95cd8b9bcaeabab04acb80fd637b79861862bead9ecc0031df5650b
+  data.tar.gz: db8f3d8ad90967b1316ecbbe62ff926352477e9767ae5b8854d2a6601a57f3ef2dbe47d7313be5622760701749914fa4077efbb0c054374aa9c56469df6e55a7

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -1,6 +1,55 @@
 # Rubyenum
 
-TODO: Write a gem description
+RubyEnum is a simple implemenation of the enum pattern that you see in java, c++, etc. Why use a pattern from a scary laguage like java when we have ruby? Because Enums are awesome. Anytime you have a variety of types for an object that are merely classification, and not deserving of objects themselves, you can use an enum. 
+
+For instance, if you have a User class that has a role attribute (admin, editor, viewer) in the past you either did:
+- a) store an integer in the database and have a long list of constants to use throughout your code (the better option)
+- b) Stored strings in the database like `"admin"`, or `"editor"` (the terrible option)
+
+Enter enums
+
+an Enum is an object that has it's own final state (such as an integer for the data), as well as a variety of methods allowing you to act upon that state. For example, this is how you might define a UserRoles enum with RubyEnum
+
+```
+class UserRoles < RubyEnum::Base
+    
+    fields :id, :permissions
+
+    enum :ADMIN, 0, "all"
+    enum :EDITOR, 1, "read/write"
+    enum :VIEWER, 2, "read"
+
+end
+
+``` 
+
+After defining the enum, you can access an instance of it via the constant and access its properties like so:
+
+```
+role = UserRoles::ADMIN
+role.name #=> "ADMIN" (built in method)
+role.id #=> 0
+role.permissions #=> "all"
+```
+
+You can also go backwards from a field:
+```
+i = 1
+name = "VIEWER"
+UserRoles.from_id(i) #=> UserRoles::EDITOR
+UserRoles.value_of(name) #=> UserRoles::VIEWER
+```
+
+Finally, they are grouped together, so you can access them all as an array:
+```
+UserRoles.all #=> [UserRoles::ADMIN, UserRoles::EDITOR, UserRoles::VIEWER]
+```
+
+Together, this all makes for a far more flexible, yet still very stable, method of defining constants throughout the app.
+
+## With rails
+
+
 
 ## Installation
 

data/lib/rubyenum/version.rb

@@ -1,3 +1,3 @@
 module Rubyenum
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/rubyenum.rb

@@ -1,4 +1,5 @@
 require "rubyenum/version"
+require "pry"
 
 module RubyEnum 
 
@@ -22,6 +23,16 @@ module RubyEnum
     def self.fields(*args) 
       args.each do |argument|
         @@fields << argument
+        define_singleton_method("from_#{argument.to_s}") do |value|
+          item_to_return = nil
+          @@all.each do |item|
+            if item.send(argument) == value 
+              item_to_return = item
+              break
+            end
+          end
+          item_to_return
+        end
       end
     end
 
@@ -41,6 +52,10 @@ module RubyEnum
       @@all << enumObj
     end
 
+    def initialize(name)
+      @name = name
+    end
+    
     def add_attribute(attr_name, value)
       var = instance_variable_set(:"@#{attr_name}", value)
       define_singleton_method("#{attr_name}") do 
@@ -48,26 +63,46 @@ module RubyEnum
       end
     end
 
-    def initialize(name)
-      @name = name
-    end
 
 
   end
 
-  ## depends on rails
-  module Associations 
+  module Associations
+
+    # let ActiveRecord define these if using rails 
+    def create_helper_methods
+      unless respond_to? :read_attribute
+        define_method(:read_attribute) do |name|
+          instance_variable_get(:"@#{name}")
+        end
+      end
+      unless respond_to? :write_attribute
+        define_method(:write_attribute) do |name, value|
+          instance_variable_set(:"@#{name}", value)
+        end
+      end
+    end
+
+    def to_camelcase(string)
+      return_string = ""
+      parts = string.split("_")
+      parts.each do |part|
+        part[0] = part[0].upcase
+        return_string += part
+      end
+      return_string
+    end
 
     def enumify(method_name, hash)
-      klass = Object.const_get(hash[:with].to_s.camelize)
-      
+      create_helper_methods
+      klass = Object.const_get(to_camelcase(hash[:with].to_s))
       define_method(method_name) do 
         enum_to_return = nil
         var = read_attribute(method_name)
         klass.all.each do |item|
           if item.send(hash[:use]) == var
             enum_to_return = item
-            break;
+            break
           end
         end
         enum_to_return
@@ -101,11 +136,9 @@ end
 
 #   extend RubyEnum::Associations
 
-#   attr_accessor :animal
-
 #   enumify :animal, :with => :animal_example, :use => :id
 
-#   # overides getter and setter methods 
+#   # writes getter and setter methods 
 #     # animal=(AnimalExample), sets the property to the :use value @animal = id
 #     # animal => AnimalExample, gets the property from the :use value and converts to Enum
 

data/rubyenum.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
 end

data/spec/rubyenum_associations_spec.rb

@@ -0,0 +1,24 @@
+require 'rubyenum'
+require 'spec_helper'
+require 'user_role_fixture'
+
+describe RubyEnum::Associations do
+  
+  before(:each) do 
+    @user = User.new
+    @user.role = UserRole::ADMIN
+
+  end
+
+  describe "#role" do
+    it "stores the value of the assigned field" do 
+      expect(@user.instance_variable_get(:"@role")).to be 0
+    end
+    
+    it "returns the enum of the user" do
+      expect(@user.role).to eq(UserRole::ADMIN)
+    end
+
+  end
+
+end

data/spec/rubyenum_base_spec.rb

@@ -0,0 +1,52 @@
+require 'rubyenum'
+require 'spec_helper'
+require 'user_fixture'
+
+describe RubyEnum::Associations do
+    
+  describe "#all" do
+    it "returns a array of the enums" do
+      enums = UserRole.all
+      expect(enums.size).to be 3
+      expect(enums[0]).to eq UserRole::ADMIN
+    end
+  end
+
+  describe "#new" do 
+    it "does not allow instantiation" do 
+      expect { UserRole.new }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe "#value_of" do
+    it "returns the proper enum for a string" do
+      enum = UserRole.value_of "EDITOR"
+      expect(enum).to eq UserRole::EDITOR
+    end
+
+    it "returns the proper enum for a symbol" do
+      enum = UserRole.value_of :READER
+      expect(enum).to eq UserRole::READER
+    end
+  end
+
+  describe ".fields" do
+    it "creates methods to access enum from each field" do 
+      enum = UserRole.from_id 1
+      expect(enum).to eq UserRole::EDITOR
+
+      enum = UserRole.from_permission "all"
+      expect(enum).to eq UserRole::ADMIN
+    end
+  end
+
+  describe "#get_fields" do
+    it "returns an array of the defined fields" do 
+      fields = UserRole.get_fields
+      expect(fields.size).to be 2
+
+      expect(fields.include? :id).to be true
+      expect(fields.include? :permission).to be true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/user_fixture.rb

@@ -0,0 +1,7 @@
+require 'user_role_fixture'
+
+class User
+  extend RubyEnum::Associations
+
+  enumify :role, :with => :user_role, :use => :id
+end

data/spec/user_role_fixture.rb

@@ -0,0 +1,7 @@
+class UserRole < RubyEnum::Base
+  fields :id, :permission
+
+  enum :ADMIN, 0, "all"
+  enum :EDITOR, 1, "read/write"
+  enum :READER, 2, "read"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyenum
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - georgemayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: provides enum functionality for ruby
 email:
 - mayer.georgep@gmail.com
@@ -46,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -53,6 +82,11 @@ files:
 - lib/rubyenum.rb
 - lib/rubyenum/version.rb
 - rubyenum.gemspec
+- spec/rubyenum_associations_spec.rb
+- spec/rubyenum_base_spec.rb
+- spec/spec_helper.rb
+- spec/user_fixture.rb
+- spec/user_role_fixture.rb
 homepage: ''
 licenses:
 - MIT
@@ -77,4 +111,9 @@ rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: provides enum functionality for ruby
-test_files: []
+test_files:
+- spec/rubyenum_associations_spec.rb
+- spec/rubyenum_base_spec.rb
+- spec/spec_helper.rb
+- spec/user_fixture.rb
+- spec/user_role_fixture.rb