better_helpers 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 177556adb63a634d36214319a642a9a5fc058817
+  data.tar.gz: 43af52bb3c31ac178b90728bad4ccfdcfbc37779
+SHA512:
+  metadata.gz: 73bc5487a07a4c4e712e7e6f037a7cf5e3c47f610998ce91ed2346d4abab57d2a39dc1255344d6afd7adb96c1b9cc7a4dd26098de546e12dffbd16ca24a52686
+  data.tar.gz: d798c4bdba0e27e5cac1ce41795314dc0c9eae9681ae2a31f313d9aa997c8f1ca7c04f8faa76675d4363c4e40d2fccc49c68c745b8a2b89238dfc8ca58ab5e56

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/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+better_helpers

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 tulios
+
+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,122 @@
+# BetterHelpers
+
+[![Gem Version](https://badge.fury.io/rb/better_helpers.png)](http://badge.fury.io/rb/better_helpers)
+
+It is a better way to organize and maintain your Rails helpers. It's provide a simple pattern to keep your helpers scoped, avoiding conflicts in the global namespace.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'better_helpers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install better_helpers
+
+## Usage
+
+BetterHelpers is magic free, it does nothing if you do not want. It is 100% compatible with your old helpers and will only activate under your command.
+
+The usage is very simple, add the module **BetterHelpers::Base** in your helper module and create the methods inside the "DSL" **better_helpers**, like:
+
+```ruby
+module ProfileHelper
+  include BetterHelpers::Base
+
+  better_helpers do
+
+    def username string
+      link_to(string, "/username/#{string}")
+    end
+
+  end
+end
+```
+
+It will create the namespace *profile_helper* based on the underscore name of module, to use in your views is as simple as:
+
+```sh
+<%= profile_helper.username "name" %>
+```
+
+It also work with modules, consider the example:
+
+```ruby
+module Admin
+  module Users
+    module ProfileHelper
+      include BetterHelpers::Base
+
+      better_helpers do
+
+        def username string
+          "admin #{string}"
+        end
+
+      end
+    end
+  end
+end
+```
+
+```sh
+<%= admin.users.profile_helper.username "name" %>
+```
+
+By default, it will create the whole hierarchy but it is possible to define the namespace, check the section **Defining the namespace** to understand how to proceed.
+
+BetterHelpers will include in the namespace just the methods inside the "DSL", you could keep your "old fashion" helpers inside the module without problems.
+
+### Defining the namespace
+
+Just pass a symbol to the "DSL" and it's done.
+
+```ruby
+module HomeHelper
+  include BetterHelpers::Base
+
+  better_helpers :custom_namespace do
+
+    def title
+      "<h1>HOME</h1>".html_safe
+    end
+
+  end
+end
+```
+
+```sh
+<%= custom_namespace.title %>
+```
+
+```ruby
+module MyModule
+  module MyHelper
+    include BetterHelpers::Base
+
+    better_helpers :custom do
+
+      def helper_method
+      end
+
+    end
+  end
+end
+```
+
+```sh
+<%= custom.helper_method %>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/better_helpers.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'better_helpers/version'
+
+Gem::Specification.new do |s|
+  s.name          = "better_helpers"
+  s.version       = BetterHelpers::VERSION
+  s.authors       = ["tulios"]
+  s.email         = ["ornelas.tulio@gmail.com"]
+  s.description   = %q{It is a better way to organize and maintain your Rails helpers. It's provide a simple pattern to keep your helpers scoped, avoiding conflicts in the global namespace}
+  s.summary       = %q{It is a better way to organize and maintain your Rails helpers}
+  s.homepage      = "https://github.com/tulios/better_helpers"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency "railties", ">= 3.2"
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+end

data/lib/better_helpers.rb

@@ -0,0 +1,10 @@
+require "active_support/core_ext/string/inflections"
+require "action_view"
+
+require "better_helpers/version"
+require "better_helpers/base"
+require "better_helpers/namespace_to_hash"
+require "better_helpers/hash_to_object"
+
+module BetterHelpers
+end

data/lib/better_helpers/base.rb

@@ -0,0 +1,30 @@
+module BetterHelpers
+  module Base
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def better_helpers namespace = nil, &block
+        helper_class = Class.new(&block)
+        helper_class.class_eval do
+          include ActionView::Helpers
+          include ActionView::Context
+          extend ActionView::Helpers
+          extend ActionView::Context
+        end
+
+        namespace ||= self.to_s.underscore
+        names = namespace.to_s.split("/")
+        name = names.shift
+
+        hash = NamespaceToHash.new(helper_class, names).perform
+        value = HashToObject.new(hash).perform
+
+        self.send(:define_method, name) { value }
+      end
+    end
+
+  end
+end

data/lib/better_helpers/hash_to_object.rb

@@ -0,0 +1,28 @@
+module BetterHelpers
+  class HashToObject
+    def initialize obj
+      @obj = obj
+    end
+
+    def perform
+      generate_obj @obj
+    end
+
+    private
+    def generate_obj obj
+      if obj.is_a? Hash
+        key = obj.keys.first
+        value = obj[key]
+
+        return value if key.nil?
+        return_obj = generate_obj value
+
+        c = Class.new
+        c.send(:define_method, key) { return_obj }
+        return c.new
+      end
+
+      obj
+    end
+  end
+end

data/lib/better_helpers/namespace_to_hash.rb

@@ -0,0 +1,25 @@
+module BetterHelpers
+  class NamespaceToHash
+    def initialize helper_class, names
+      @helper_class = helper_class
+      @names = names.clone
+    end
+
+    def perform
+      generate_hash @names.shift, @names, {}
+    end
+
+    private
+    def generate_hash name, names, hash
+      if names.empty?
+        hash[name] = @helper_class.new
+
+      else
+        hash[name] = {}
+        generate_hash(names.shift, names, hash[name])
+      end
+
+      hash
+    end
+  end
+end

data/lib/better_helpers/version.rb

@@ -0,0 +1,3 @@
+module BetterHelpers
+  VERSION = "0.1.1"
+end

data/spec/better_helpers/base_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+require "fixtures/some_helper"
+require "fixtures/another_helper"
+require "fixtures/inside_module_helper"
+require "fixtures/inside_module_custom_helper"
+
+describe BetterHelpers::Base do
+
+  let :helpers do
+    Module.new do
+      extend SomeHelper
+      extend AnotherHelper
+      extend InsideModuleHelper::A::B
+      extend InsideModuleCustomHelper::A::B
+    end
+  end
+
+  it "should not conflict with old helpers" do
+    helpers.should respond_to :global_helper_method
+    helpers.global_helper_method.should eql "test5"
+  end
+
+  describe "when included" do
+    it "should include the class method 'better_helpers'" do
+      SomeHelper.should respond_to :better_helpers
+      AnotherHelper.should respond_to :better_helpers
+    end
+  end
+
+  describe "::better_helpers" do
+    describe "without arguments" do
+      it "should include the helper methods into a 'namespace' with the underscore name of the module" do
+        helpers.should respond_to SomeHelper.to_s.underscore
+        helpers.some_helper.helper_method.should eql "test"
+      end
+    end
+
+    describe "with namespace argument" do
+      it "should include the helper methods into the defined 'namespace'" do
+        helpers.should respond_to :another
+        helpers.another.helper_method.should eql "test2"
+      end
+    end
+
+    context "for helpers inside modules" do
+      it "should include as cascade methods" do
+        helpers.should respond_to :inside_module_helper
+        helpers.inside_module_helper.should respond_to :a
+        helpers.inside_module_helper.a.should respond_to :b
+        helpers.inside_module_helper.a.b.helper_method.should eql "test3"
+      end
+
+      it "should allow namespace configuration" do
+        helpers.should respond_to :custom_helper
+        helpers.custom_helper.helper_method.should eql "test4"
+      end
+    end
+  end
+
+end

data/spec/better_helpers/hash_to_object_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe BetterHelpers::HashToObject do
+
+  let :hash do
+    {
+      a: {
+        b: {
+          c: 1
+        }
+      }
+    }
+  end
+
+  subject do
+    BetterHelpers::HashToObject.new(hash).perform
+  end
+
+  it "should generate nested objects following the hash structure" do
+    subject.should respond_to :a
+    subject.a.should respond_to :b
+    subject.a.b.should respond_to :c
+    subject.a.b.c.should eql 1
+  end
+
+  describe "when key is nil" do
+    let :hash do
+      {nil => 1}
+    end
+
+    it "should return the value" do
+      subject.should eql 1
+    end
+  end
+
+end

data/spec/better_helpers/namespace_to_hash_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe BetterHelpers::NamespaceToHash do
+
+  let :namespace do
+    ["a", "b", "c"]
+  end
+
+  subject do
+    BetterHelpers::NamespaceToHash.new(String, namespace).perform
+  end
+
+  it "should generate a nested hash resulting in the given object" do
+    subject.should be_an_instance_of Hash
+    subject.keys.should eql ["a"]
+
+    subject["a"].should be_an_instance_of Hash
+    subject["a"].keys.should eql ["b"]
+
+    subject["a"]["b"].should be_an_instance_of Hash
+    subject["a"]["b"].keys.should eql ["c"]
+    subject["a"]["b"]["c"].should be_an_instance_of String
+  end
+
+end

data/spec/fixtures/another_helper.rb

@@ -0,0 +1,15 @@
+module AnotherHelper
+  include BetterHelpers::Base
+
+  def global_helper_method
+    "test5"
+  end
+
+  better_helpers :another do
+
+    def helper_method
+      "test2"
+    end
+
+  end
+end

data/spec/fixtures/inside_module_custom_helper.rb

@@ -0,0 +1,15 @@
+module InsideModuleCustomHelper
+  module A
+    module B
+      include BetterHelpers::Base
+
+      better_helpers :custom_helper do
+
+        def helper_method
+          "test4"
+        end
+
+      end
+    end
+  end
+end

data/spec/fixtures/inside_module_helper.rb

@@ -0,0 +1,15 @@
+module InsideModuleHelper
+  module A
+    module B
+      include BetterHelpers::Base
+
+      better_helpers do
+
+        def helper_method
+          "test3"
+        end
+
+      end
+    end
+  end
+end

data/spec/fixtures/some_helper.rb

@@ -0,0 +1,11 @@
+module SomeHelper
+  include BetterHelpers::Base
+
+  better_helpers do
+
+    def helper_method
+      "test"
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+ENV['RACK_ENV'] = 'test'
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "better_helpers"
+
+# 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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: better_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- tulios
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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'
+description: It is a better way to organize and maintain your Rails helpers. It's
+  provide a simple pattern to keep your helpers scoped, avoiding conflicts in the
+  global namespace
+email:
+- ornelas.tulio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- better_helpers.gemspec
+- lib/better_helpers.rb
+- lib/better_helpers/base.rb
+- lib/better_helpers/hash_to_object.rb
+- lib/better_helpers/namespace_to_hash.rb
+- lib/better_helpers/version.rb
+- spec/better_helpers/base_spec.rb
+- spec/better_helpers/hash_to_object_spec.rb
+- spec/better_helpers/namespace_to_hash_spec.rb
+- spec/fixtures/another_helper.rb
+- spec/fixtures/inside_module_custom_helper.rb
+- spec/fixtures/inside_module_helper.rb
+- spec/fixtures/some_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tulios/better_helpers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: It is a better way to organize and maintain your Rails helpers
+test_files:
+- spec/better_helpers/base_spec.rb
+- spec/better_helpers/hash_to_object_spec.rb
+- spec/better_helpers/namespace_to_hash_spec.rb
+- spec/fixtures/another_helper.rb
+- spec/fixtures/inside_module_custom_helper.rb
+- spec/fixtures/inside_module_helper.rb
+- spec/fixtures/some_helper.rb
+- spec/spec_helper.rb