jacaranda 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 jacaranda.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mauro George
+
+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,70 @@
+# Jacaranda
+
+Generates helper methods based on your model validations creating common methods and scopes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jacaranda'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jacaranda
+
+## Usage
+
+### Basic
+
+Simply add the following line **after the validations**:
+
+    acts_as_jacaranda
+
+like that
+
+    class Post < ActiveRecord::Base
+      validates :status, inclusion: { in: %w{published unpublished draft} }
+      acts_as_jacaranda
+    end
+
+Now your model Post received some powers, we see them.
+
+#### Predicate methods
+
+Ask `@post` if it was published with `@post.published?` or it is a draft with `@post.draft?`.
+
+#### Scopes
+
+Find the posts based on column `status` using the generated scopes like `Post.published` e `Post.draft`.
+
+### Scoped
+
+Perhaps model has 2 validations of inclusion that have valid values repeated
+
+    class Post < ActiveRecord::Base
+      validates :status, inclusion: { in: %w{published unpublished draft} }
+      validates :kind, inclusion: { in: %w{report unpublished draft} }
+      acts_as_jacaranda
+    end
+
+in this case use Jacaranda with the param `scoped`:
+
+    acts_as_jacaranda scoped: true
+
+which will generate methods based on column like `#unpublished_status?` and `#unpublished_kind?`.
+
+## Versioning
+
+Jacaranda follow the [Semantic Versioning](http://semver.org/).
+
+## 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,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/jacaranda.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jacaranda/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mauro George"]
+  gem.email         = ["maurogot@gmail.com"]
+  gem.description   = %q{jacaranda generates helper methods based on your model validations.}
+  gem.summary       = %q{jacaranda generates helper methods based on your model validations -
+                          creating common methods and scopes.}
+  gem.homepage      = "https://github.com/maurogeorge/jacaranda"
+
+  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          = "jacaranda"
+  gem.require_paths = ["lib"]
+  gem.version       = Jacaranda::VERSION
+
+  gem.add_dependency "activerecord", ">= 3.0.0"
+
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "pry-meta"
+end

data/lib/config/locales/en.yml

@@ -0,0 +1,16 @@
+en:
+  jacaranda:
+    errors:
+      messages:
+        unknown: "Maybe you found a bug, you got a not expected exception. Report this on https://github.com/maurogeorge/jacaranda/issues"
+        precedence: "Model %{model} has no validation of inclusion or the acts_as_jacaranda as included before the validations"
+        duplicated: "The following validators are in more than one field: %{validators}\n
+          in this case, use the scoped parameter as:\n\n
+          \_class %{model}\n
+          \_\_# Your validations\n
+          \_\_acts_as_jacaranda scoped: true\n
+          \_end"
+
+
+
+

data/lib/jacaranda.rb

@@ -0,0 +1,15 @@
+require "active_record"
+
+I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
+
+module Jacaranda
+  require "jacaranda/version"
+  require "jacaranda/errors"
+  require "jacaranda/base"
+  require "jacaranda/predicate"
+  require "jacaranda/scope"
+end
+
+
+ActiveRecord::Base.send(:include, Jacaranda)
+

data/lib/jacaranda/base.rb

@@ -0,0 +1,66 @@
+module Jacaranda 
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end 
+
+  module ClassMethods
+
+    def acts_as_jacaranda(options = {})
+      configuration.update(options)
+      begin
+        verify!
+        create_predicate_methods
+        create_scope_methods
+      rescue => e
+        if e.kind_of?(Jacaranda::JacarandaError)
+          raise e
+        else
+          raise Jacaranda::JacarandaError, I18n.translate("jacaranda.errors.messages.unknown")
+        end
+      end
+    end
+
+    private
+
+      def klazz
+        self
+      end   
+
+      def configuration
+        @configuration ||= { scoped: false }
+      end
+
+      def inclusion_validators
+        klazz.validators.delete_if do |v| 
+          v.class.to_s != "ActiveModel::Validations::InclusionValidator"
+        end 
+      end
+
+      def validators_in 
+        inclusion_validators.sum { |v| v.options[:in] }
+      end
+
+      def duplicate_validators 
+        validators_in.select { |e| validators_in.count(e) > 1 }.uniq
+      end
+
+      def verify!
+        verify_precedence!
+        verify_duplicated!
+      end
+
+      def verify_precedence!
+        return if validators_in.kind_of?(Array)
+        if validators_in.zero?
+          raise JacarandaError, I18n.translate("jacaranda.errors.messages.precedence", model: klazz.to_s)
+        end
+      end
+
+      def verify_duplicated!
+        if duplicate_validators.any?
+          raise JacarandaError, I18n.translate("jacaranda.errors.messages.duplicated", model: klazz.to_s, validators: duplicate_validators.to_sentence)
+        end
+      end
+  end
+end

data/lib/jacaranda/errors.rb

@@ -0,0 +1,6 @@
+module Jacaranda 
+  
+  class JacarandaError < StandardError
+  end
+end
+

data/lib/jacaranda/predicate.rb

@@ -0,0 +1,24 @@
+module Jacaranda 
+  module ClassMethods
+
+    private
+
+      def create_predicate_methods
+        inclusion_validators.each do |v| 
+          v.options[:in].each do |content|
+            define_method build_predicate_name(v.attributes.first, content) do
+              send(v.attributes.first) == content
+            end
+          end
+        end
+      end
+
+      def build_predicate_name(column, name)
+        if configuration[:scoped]
+          "#{name}_#{column}?"
+        else
+          "#{name}?"
+        end
+      end
+  end
+end

data/lib/jacaranda/scope.rb

@@ -0,0 +1,22 @@
+module Jacaranda 
+  module ClassMethods
+
+    private
+
+      def create_scope_methods
+        inclusion_validators.each do |v| 
+          v.options[:in].each do |content|
+            scope(build_scope_name(v.attributes.first, content), lambda { where("#{v.attributes.first} = ? ", "#{content}") })
+          end
+        end
+      end
+
+      def build_scope_name(column, name)
+        if configuration[:scoped]
+          "#{name}_#{column}"
+        else
+          name
+        end
+      end
+  end
+end

data/lib/jacaranda/version.rb

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

data/spec/jacaranda_spec.rb

@@ -0,0 +1,107 @@
+require "spec_helper"
+
+describe Jacaranda do
+
+  describe "predicate methods" do
+
+    describe "respond to created methods" do
+
+      it "with model with single validation" do
+        post = PostWithJacaranda.create(status: "published")
+        expect(post.respond_to?(:published?)).to be_true
+      end
+
+      it "with model with multiple validations" do
+        post = PostWithJacarandaAndTitleValidation.create(title: "Title", status: "published")
+        expect(post.respond_to?(:draft?)).to be_true
+      end
+
+      it "with param scoped" do
+        post = PostWithJacarandaScoped.create(status: "published")
+        expect(post.respond_to?(:published_status?)).to be_true
+      end
+    end
+
+    describe "return correct values" do
+
+      let(:post) do
+        PostWithJacaranda.create(status: "published")
+      end
+
+      it "when is true" do
+        expect(post).to be_published
+      end
+
+      it "when is false" do
+        expect(post).to_not be_draft
+      end
+    end
+  end
+
+  describe "scopes" do
+
+    it "have the scopes" do
+      expect(PostWithJacaranda.respond_to?(:published)).to be_true
+    end
+
+    it "create scoped scopes" do
+      expect(PostWithJacarandaScoped.respond_to?(:published_status)).to be_true
+    end
+
+    it "is a relation" do
+      expect(PostWithJacaranda.published).to be_kind_of(ActiveRecord::Relation)
+    end
+
+    describe "returned values" do
+
+      let!(:post_published) do
+        PostWithJacaranda.create(status: "published")
+      end
+
+      let!(:post_not_published) do
+        PostWithJacaranda.create(status: "draft")
+      end
+
+      it "return correct values" do
+        expect(PostWithJacaranda.published).to include(post_published)
+      end
+
+      it "not return incorrect values" do
+        expect(PostWithJacaranda.published).to_not include(post_not_published)
+      end
+    end
+  end
+
+  describe "errors" do
+
+    it "when included before the validations definitions" do
+      expect do
+        class PostWithJacarandaBeforeValidation < Post
+          acts_as_jacaranda
+          validates :status, inclusion: { in: %w{published unpublished draft} }
+        end
+      end.to raise_error(Jacaranda::JacarandaError, /Model PostWithJacarandaBeforeValidation has no validation of inclusion/)
+    end
+
+    it "raise error when has 2 inclusion with same name" do
+      expect do
+        class PostWithJacarandaDuplicateInclusionValue < Post
+          validates :status, inclusion: { in: %w{published unpublished draft} }
+          validates :kind, inclusion: { in: %w{report unpublished draft} }
+          acts_as_jacaranda
+        end
+      end.to raise_error(Jacaranda::JacarandaError, /The following validators are in more than one field: unpublished and draft/)
+    end
+
+    it "raise a Jacaranda::JacarandaError when has a unknown error" do
+      Post.stub(:create_predicate_methods).and_raise(StandardError)
+      expect do
+        class PostWithUnknownError < Post
+          validates :status, inclusion: { in: %w{published unplubished draft} }
+          acts_as_jacaranda
+        end
+      end.to raise_error(Jacaranda::JacarandaError, "Maybe you found a bug, you got a not expected exception. Report this on https://github.com/maurogeorge/jacaranda/issues")
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "bundler/setup"
+Bundler.require(:default, :development)
+
+require "jacaranda"
+require "#{File.dirname(__FILE__)}/support/schema.rb"
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each do |file|
+  require file
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,19 @@
+class Post < ActiveRecord::Base
+end
+
+class PostWithJacaranda < Post 
+  validates :status, inclusion: { in: %w{published unplubished draft} }
+  acts_as_jacaranda 
+end
+
+class PostWithJacarandaAndTitleValidation < Post
+  validates :title, presence: true
+  validates :status, inclusion: { in: %w{published unplubished draft} }
+  acts_as_jacaranda 
+end
+
+class PostWithJacarandaScoped < Post 
+  validates :status, inclusion: { in: %w{published unpublished draft} }
+  acts_as_jacaranda scoped: true
+end
+

data/spec/support/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Base.configurations = true
+
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table :posts do |t|
+    t.datetime :created_at
+    t.datetime :updated_at
+    t.string :title
+    t.string :status
+    t.string :kind
+  end
+end
+
+

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: jacaranda
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mauro George
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-31 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: 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: rspec
+  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: pry-meta
+  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: jacaranda generates helper methods based on your model validations.
+email:
+- maurogot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jacaranda.gemspec
+- lib/config/locales/en.yml
+- lib/jacaranda.rb
+- lib/jacaranda/base.rb
+- lib/jacaranda/errors.rb
+- lib/jacaranda/predicate.rb
+- lib/jacaranda/scope.rb
+- lib/jacaranda/version.rb
+- spec/jacaranda_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: https://github.com/maurogeorge/jacaranda
+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: jacaranda generates helper methods based on your model validations - creating
+  common methods and scopes.
+test_files:
+- spec/jacaranda_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb