simple_helpers 0.0.1 → 0.0.2

data/.travis.yml

@@ -1,2 +1,3 @@
+language: ruby
 rvm:
   - 1.9.3

data/README.md

@@ -1,16 +1,46 @@
 # Simple Helpers
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/vitormil/simple_helpers)
+[![Build Status](https://secure.travis-ci.org/vitormil/simple_helpers.png)](http://travis-ci.org/vitormil/simple_helpers)
 
 Easily create variables with I18n and interpolation support to your controllers and views.
 
 You can configure it to automaticly create some methods (like page_title, page_subtitle) or call the method **simple_helper** manually according to your needs.
 
-Examples:
-
 To display page title in your view:
 
-**<%= page_title %>**
+```ruby
+<%= page_title %>
+```
+
+### Usage
+
+You can configure an automatic behavior to your controllers setting an initializer:
+
+```ruby
+require "simple_helpers"
+
+SimpleHelpers.configure do |config|
+  config.helpers   = [:page_title]
+  config.blacklist = [SessionsController]
+  config.whitelist = []
+end
+```
+
+And/or call the method **simple_helper** manually according to your needs:
+
+```ruby
+# some examples
+simple_helper :page_subtitle, :sponsor, :title => @post.title
+@sponsor_options.merge!({:company => "Github"})
+
+page_subtitle "Keep Calm and %{text}", :text => "Call Batman"
+page_subtitle "Keep Calm"
+
+simple_helper :user_alert
+@user_alert_options = {:username => @post.author}
+```
 
-Setting page title from I18n files.
+If you didn't set the value manually, the gem will get it from your I18n backend.
 
 ```ruby
 en:
@@ -20,6 +50,15 @@ en:
     users:
       new: "Sign up"
       show: "%{name}'s Page"
+  subtitles:
+    simple_helper_default:
+      "Default page subtitle"
+  user_alerts:
+    users:
+      index: "This alert goes to %{username}"
+  sponsors:
+    simple_helper_default:
+      "The article %{title} is sponsored by %{company}."
 ```
 
 ### Interpolation
@@ -29,7 +68,7 @@ In many cases you want to abstract your translations so that variables can be in
 ```ruby
 page_title :name => @user.name
 or
-page_title_options.merge!({:name => "John Doe"})
+@page_title_options.merge!({:name => "John Doe"})
 or
 simple_helper :page_title, :name => "John Doe"
 ```
@@ -80,33 +119,44 @@ This means that the I18n scope for the action "the_custom_action" will be the sa
 You can also specify a custom location at the "scope" key at the options hash, like rails does.
 
 ```ruby
-simple_helper :page_title, :scope => "my.awesome.chain", :name => "John Doe"
+simple_helper :page_title, :scope => "my.awesome.chain", :name => "John"
 or
-page_title_options.merge!({:scope => "my.awesome.chain", :name => "John Doe"})
+simple_helper :page_title
+@page_title_options = {:scope => "my.awesome.chain", :name => "John"}
 ```
 
-### Usage
-
-Other examples that could be called in your controllers:
+Make sure you have this scope defined in a locale file:
 
 ```ruby
-simple_helper :page_subtitle, :special_message, :title => @post.title
-special_message_options.merge({:author => @post.author.name})
-page_subtitle "Keep Calm and %{text}", :text => "Call Batman"
-simple_helper :user_alert
+en:
+  my:
+    awesome:
+      chain: "What's up %{name}?"
 ```
 
 ## Getting started
 
+### Instalation
+
+```ruby
+gem install simple_helpers
+```
+
+### Setup
+
 Simple helpers works with Rails 3.0 onwards. You can add it to your Gemfile with:
 
-**gem 'simple_helpers'**
+```ruby
+gem 'simple_helpers'
+```
 
 Run the bundle command to install it.
 
 After you install and add it to your Gemfile, you need to run the generator to create the initializer file. In this file you will configure the default behavior to your controllers.
 
-**rails generate simple_helpers**
+```ruby
+rails generate simple_helpers
+```
 
 Take a look at the generated file:
 

data/Rakefile

@@ -3,3 +3,5 @@ require "bundler/gem_tasks"
 
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/simple_helpers/action_controller.rb

@@ -20,8 +20,8 @@ module SimpleHelpers
           end
 
           define_method("#{name}_options") do
-            options = instance_variable_get "@#{name}_options"
-            options ||= {}
+            instance_variable_set("@#{name}_options", {}) unless instance_variable_get("@#{name}_options")
+            instance_variable_get("@#{name}_options")
           end
 
           define_method("#{name}_set") do |*args|
@@ -37,13 +37,13 @@ module SimpleHelpers
 
             result      = value % options unless value.nil?
 
-            # TODO: refactor
-            new_options = options.delete_if{|k,v| k.to_sym == :scope}
+            # removing rails reserved word
+            helper_options = options.delete_if{|k,v| k.to_sym == :scope}
 
-            result ||= t(scopes[:first], new_options)
+            result ||= t(scopes[:first], helper_options)
             if result.include? "translation missing" and scopes.has_key? :second
-              new_options.merge! :default => result
-              result = t(scopes[:second], new_options)
+              helper_options.merge! :default => result
+              result = t(scopes[:second], helper_options)
             end
 
             result

data/lib/simple_helpers/railtie.rb

@@ -8,7 +8,6 @@ module SimpleHelpers
     end
 
     initializer "simple_helpers.initialize" do
-
       ::ActionController::Base.instance_eval do
         include SimpleHelpers::ActionController
 
@@ -23,9 +22,7 @@ module SimpleHelpers
 
           initialize_method.bind(self).call(*args)
         end
-
       end
-
       ::I18n.load_path += Dir[File.dirname(__FILE__) + "/../../locales/*.yml"]
     end
   end

data/lib/simple_helpers/version.rb

@@ -2,7 +2,7 @@ module SimpleHelpers
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 1
+    PATCH = 2
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-17 00:00:00.000000000 Z
+date: 2012-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -124,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3047608726697320755
+      hash: 2960162122361549909
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3047608726697320755
+      hash: 2960162122361549909
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23