entity_status 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b9055d9bc4b1e2183811345e24badeb103964f6
+  data.tar.gz: 9cd7237e3d61c0db38933a0894ca58d10beea598
+SHA512:
+  metadata.gz: 785f9970f80d3e701333347fb62a0b6f0fec35437c126e68943acffc9f00f5d28495d78efe8fc935d064b2f4308386f388a78670d3b26037a90fbbb5137d8666
+  data.tar.gz: db165a4c878892483d4ac452ced51804410f3644e3a5242e604902a18879787d8b39a72cafb19b4c855e22988cb74539e24a6a7c3de6236ee405debee44e271a

data/.gitignore

@@ -0,0 +1,16 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jeremy Bueler
+
+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 @@
+entity_status
+=============
+
+Ruby Gem for adding status helper methods to an activerecord model.
+
+### Installlation
+
+		gem 'entity_status', git: 'git@github.com:jbueler/entity_status.git'
+
+Bundle install
+
+This gem will modify a string column in your database and is configurable to which column you want to use.
+To change the column used for the status call `entity_status <#column_name#>`
+
+Include module in your Model, this will get you default statuses of `pending`, `open`, `closed`
+
+		class Post < ActiveRecord::Base
+			include EntityStatus # the default column EntityStatus will look for is `status`
+		end
+
+You can configure custom statuses per model by calling entity_status in your Model:
+
+		class Post < ActiveRecord::Base
+			include EntityStatus
+			entity_status :status, [:incomplete,:complete]
+		end
+
+You can configure multiple status columns per model by calling entity_status multiple times in your Model:
+
+		class Post < ActiveRecord::Base
+			include EntityStatus
+			entity_status :status, [:incomplete,:complete]
+			entity_status :moderation_status, [:pending,:approved,:rejected]
+		end
+
+### Using EntityStatus
+You can now start using the helper methods:
+
+		Post.incomplete #=> will return all Post entities with status == 'incomplete'
+		p = Post.incomplete.first
+		p.complete? #=> false
+		p.complete #=> returns p with p.status == 'complete'
+		p.complete? #=> true
+		
+		// USING THE SECOND ENTITY STATUS
+		p.approved #=> returns p with p.moderation_status == 'approved'		
+		if(p.approved? && p.complete?)
+			// THIS IS APPROVED AND COMPLETED
+		elsif(!p.approved?)
+			// THIS IS NOT APPROVED
+		end
+		
+

data/entity_status.gemspec

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require File.expand_path("../lib/entity_status/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name              = "entity_status"
+  s.version           = EntityStatus::VERSION
+  s.authors           = ["Jeremy Bueler"]
+  s.email             = ["jbueler@gmail.com"]
+  s.homepage          = "https://github.com/jbueler/entity_status"
+  s.summary           = "Simple entity status module for fetching and setting entities by status string."
+  # s.rubyforge_project = "friendly_id"
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- {test}/*`.split("\n")
+  s.require_paths     = ["lib"]
+  s.license           = 'MIT'
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'activerecord'
+
+  # s.add_development_dependency 'railties', '~> 4.0.0'
+  # s.add_development_dependency 'minitest', '>= 4.4.0'
+  # s.add_development_dependency 'mocha', '~> 0.13.3'
+  # s.add_development_dependency 'yard'
+  # s.add_development_dependency 'i18n'
+  # s.add_development_dependency 'ffaker'
+  # s.add_development_dependency 'simplecov'
+  # s.add_development_dependency 'redcarpet'
+
+  s.description = <<-EOM
+  A simple work in progress gem for adding status string to activerecord models.
+  Creates scopes and status setting/testing methods.
+EOM
+end

data/lib/entity_status/version.rb

@@ -0,0 +1,3 @@
+module EntityStatus
+  VERSION = "0.0.2"
+end

data/lib/entity_status.rb

@@ -0,0 +1,87 @@
+class Object
+  # GIVES US THE ABILITY TO ADD DYNMAIC CLASS METHODS TO THE STATUSES MODULE....
+  # http://ryanangilly.com/post/234897271/dynamically-adding-class-methods-in-ruby
+  def metaclass
+    class << self; self; end
+  end
+end
+
+module EntityStatus
+  extend ActiveSupport::Concern
+  module ClassMethods
+    def entity_status(column_name="status",status_array = [])
+      status_array = (status_array.count > 0) ? status_array : %W(pending open closed)
+      self.create_statuses_method(column_name.to_s.pluralize,status_array)
+      status_array.each do |st|
+        self.create_finder_methods(column_name,st)
+        
+        # add dynamic state setters based on the status string
+        # example: Post.first.pending #=> 'pending'
+        define_method st do
+          self.send("#{column_name}=".to_sym,st.to_s)
+          self
+        end
+    
+        # Add boolean state checks based on the status string
+        # example: Post.first.pending? #=> true
+        define_method "#{st}?" do
+          (self.send(column_name) == st) ? true :false
+        end
+      end
+      
+    end
+
+    def create_statuses_method(name,statuses)
+      klass = self.to_s
+      metaclass.instance_eval do
+        # attr_accessor :statuses        
+        # @@statuses = statuses
+        define_method(name){
+          return statuses
+        }
+      end
+    end
+
+    def create_finder_methods(column_name,name)
+      klass = self.to_s
+      metaclass.instance_eval do
+        define_method(name){
+          where(column_name.to_sym => name)
+        }
+      end
+    end
+    
+  end
+
+  module InstanceMethods
+    def state
+      self.status.to_s
+    end
+
+    def dependant_state_update(state)
+      self.update_attributes status: state
+      self.reflections.each do |rel|
+        if rel.last.klass.method_defined? :dependant_state_update
+          if rel.last.options[:dependent] == :destroy
+            items = [] + self.send(rel.last.name)
+            items.each do |item|
+              item.dependant_state_update state
+            end
+          end
+        end
+      end
+    end
+    
+  end
+
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+    receiver.entity_status if receiver.respond_to? :entity_status
+      
+    if receiver.method_defined?(:attr_accessible)
+      receiver.attr_accessible :status
+      # receiver.after_create :default_status
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: entity_status
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jeremy Bueler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+    A simple work in progress gem for adding status string to activerecord models.
+    Creates scopes and status setting/testing methods.
+email:
+- jbueler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- entity_status-0.0.1.gem
+- entity_status.gemspec
+- lib/entity_status.rb
+- lib/entity_status/version.rb
+homepage: https://github.com/jbueler/entity_status
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: Simple entity status module for fetching and setting entities by status string.
+test_files: []