simple_helpers 1.0.0 → 2.0.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3760bdc12e9255f34b9063c8cd29e114ccf6575d
+  data.tar.gz: 78da44fe321d6a08c0e2ad04e1efc06ff790f1ee
+SHA512:
+  metadata.gz: 8913a3406650bb585131a0e6b0fa36fac915d1c8f2059284ac47617177e1896a7c6d432f07232656c5b05068b7b35909ed884d5039fe3d8091a548c4528c360c
+  data.tar.gz: ae85af3ed3457fec3ca431e88b679a627cd55eb799483b286775d6aca8aea33e2654fcfd5a5853798afc35bc472fc4e80fee486fdd0ddc59d0281e87cebe1479

data/CHANGELOG.md

@@ -1,15 +1,3 @@
-## v0.0.4
+## v2.0.0
 
-* config.blacklist renamed to except and config.whitelist to only
-
-## v0.0.3
-
-* Automatic pluralize I18n scope names is no longer the default behavior
-
-## v0.0.2
-
-* Patch for "#{name}_options" instance_variable_set
-
-## v0.0.1
-
-* initial release
+- I18n support and *easy interpolation*

data/README.md

@@ -2,9 +2,9 @@
 [![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)
 
-Allow you to easily create helper methods with I18n and interpolation support to be used in your controllers and views.
+Allow you to easily create helper methods with I18n support and **easy interpolation** with instance variables and methods.
 
-You can configure it to automaticly create some methods (like page_title) or call the method **simple_helper** manually according to your needs.
+## Example
 
 To display page title in your view:
 
@@ -15,134 +15,49 @@ To display page title in your view:
 </head>
 ```
 
-### 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.except  = [SessionsController]
-  # config.only    = []
-end
-```
-
-And/or call the method **simple_helper** manually according to your needs:
-
-```ruby
-# declaring one method
-simple_helper :page_subtitle, :title => @post.title
-
-# declare multiple helpers in one statement
-simple_helper :sponsor, :page_footer, :title => @post.title
-
-# An instance variable **@<helper-method-name>_options** is created for customizations
-@sponsor_options.merge!({:company => "Github"})
-
-page_footer "Post %{title} by %{author}"
-@page_footer_options = { :author => @post.author }
-
-simple_helper :user_alert
-@user_alert_options = {:username => current_user.username }
-
-# filling in the value manually
-page_title @post.title
-```
-
-If you didn't set the value manually, the gem will get it from your I18n backend.
+Create a file `./config/locale/simple_helpers.yml` (could be another name) to store the values, following the convention: `<helper>.<controller>.<action>`
 
 ```ruby
 en:
   page_title:
-    simple_helper_default:
-      "Default page title"
+    posts:
+      new: "New Post"
+      show: "{{@post.title}}"
+      edit: "Editing {{@post.title}}"
+      search: "Search results for {{@query}}..."
     users:
-      new: "Sign up"
-      show: "%{name}'s Page"
-  page_subtitle:
-    simple_helper_default:
-      "Default page subtitle"
-  user_alert:
-    users:
-      index: "This alert goes to %{username}"
-  sponsor:
-    simple_helper_default:
-      "This article %{title} is sponsored by %{company}."
-```
-
-### Interpolation
-
-In many cases you want to abstract your translations so that variables can be interpolated into the translation, just like Rails does.
-
-```ruby
-page_title :name => "John Doe"
-or
-@page_title_options.merge!({:name => "John Doe"})
-or
-simple_helper :page_title, :name => "John Doe"
+      show: "{{@user.name}}'s profile"
+      new: "{{get_title}}"
+      edit: "Edit user"
+      destroy: "Delete user"
 ```
 
-### Aliases
-
-There are some action aliases:
-
-```ruby
-"create" => "new"
-"update" => "edit"
-"remove" => "destroy"
-```
+### Easy Interpolation
 
-I18n backend chain:
+Simple helpers will look for instance variables and methods in the controller, and get the value to interpolate with the i18n values. Awesome!!! :)
 
-```ruby
-en:
-  <helper method name>:
-    simple_helper_default:
-      "My default data"
-    <controller>:
-      <action>: "My custom data for this action"
-```
+### Configuration
 
-Adding custom aliases:
+Initializer `./config/initializers/simple_helpers.rb`
 
 ```ruby
-class PostsController < ApplicationController
+require "simple_helpers"
 
-  SIMPLE_HELPER_ALIASES = {
-    "the_custom_action" => "index"
+SimpleHelpers.configure do |config|
+  config.helpers = {
+    page_title: { prefix: "MyBlog", separator: " - " }
   }
-
-  def index
-    ...
-  end
-
-  def the_custom_action
-    ...
-  end
-
 end
 ```
 
-This means that the I18n scope for the action "the_custom_action" will be the same as "index".
-
-You can also specify a custom location at the "scope" key at the options hash, exactly like Rails does.
-
-```ruby
-simple_helper :page_title, :scope => "my.awesome.chain", :name => "John"
-or
-simple_helper :page_title
-@page_title_options = {:scope => "my.awesome.chain", :name => "John"}
-```
+### Aliases
 
-Make sure you have this scope defined in a locale file:
+There are some action aliases:
 
 ```ruby
-en:
-  my:
-    awesome:
-      chain: "What's up %{name}?"
+"create" => "new"
+"update" => "edit"
+"remove" => "destroy"
 ```
 
 ## Getting started
@@ -169,20 +84,10 @@ After you install and add it to your Gemfile, you need to run the generator to c
 rails generate simple_helpers
 ```
 
-Take a look at the generated file:
-
-https://github.com/vitormil/simple_helpers/blob/master/templates/initializer.rb
-
 ## Maintainer
 
 * Vitor Oliveira (<http://github.com/vitormil>)
 
-## Special thanks
-
-I have been learning a lot with Nando Vieira and this gem was inspired by the "page_title" feature from his gem @swiss_knife.
-
-Thanks @fnando! (<http://github.com/fnando>)
-
 ## Contributing
 
 1. Fork it

data/lib/simple_helpers/action_controller.rb

@@ -1,22 +1,14 @@
 module SimpleHelpers
   module ActionController
-    def simple_helper(*name_or_array_of_names)
-      main_options   = name_or_array_of_names.extract_options!
-      array_of_names = SimpleHelpers::Support.certified_array!(name_or_array_of_names)
+    def simple_helper(helpers_array)
+      helpers_array.each do |name|
+        name = name.to_s.underscore
 
-      SimpleHelpers::Support.log "Defining methods #{array_of_names.inspect} to #{self.class.inspect}"
-
-      array_of_names.each do |name_symbol|
-        name = name_symbol.underscore
-
-        # define_methods
+        # method
         SimpleHelpers::Support.create_method(self, name)
 
-        # method helper
-        ::ActionController::Base.helper_method name.to_s
-
-        # initialize
-        instance_variable_set "@#{name}_options", Hash[main_options] unless main_options.empty?
+        # helper
+        ::ActionController::Base.helper_method name
       end
     end
   end

data/lib/simple_helpers/config.rb

@@ -1,36 +1,11 @@
 module SimpleHelpers
   class Config
-
-    VALID_OPTIONS = [:log, :pluralize]
-
-    def self.only
-      @only ||= []
-    end
-
-    def self.only=(*allowed)
-      @only = SimpleHelpers::Support.certified_array!(allowed)
-    end
-
-    def self.except
-      @except ||= []
-    end
-
-    def self.except=(*not_allowed)
-      @except = SimpleHelpers::Support.certified_array!(not_allowed)
-    end
-
     def self.helpers
-      @helpers ||= []
+      @helpers ||= {}
     end
 
-    def self.helpers=(*helper_methods)
-      @helpers = SimpleHelpers::Support.certified_array!(helper_methods)
-    end
-
-    def self.allowed_controller?(controller)
-      ( @only.empty? and @except.empty? ) or
-      ( not @only.empty? and @only.include?(controller) ) or
-      ( not @except.empty? and not @except.include?(controller) )
+    def self.helpers=(helper_methods)
+      @helpers = helper_methods
     end
 
     def self.options
@@ -45,6 +20,5 @@ module SimpleHelpers
     def self.has_option?(option)
       @options.include?(option.to_sym)
     end
-
   end
 end

data/lib/simple_helpers/railtie.rb

@@ -14,11 +14,7 @@ module SimpleHelpers
         initialize_method = instance_method(:initialize)
 
         define_method :initialize do |*args|
-          if SimpleHelpers::Config.allowed_controller?(self.class.name)
-            simple_helper(SimpleHelpers::Config.helpers)
-          else
-            SimpleHelpers::Support.log "Controller #{self.class.inspect} not allowed."
-          end
+          simple_helper(SimpleHelpers::Config.helpers.keys)
 
           initialize_method.bind(self).call(*args)
         end

data/lib/simple_helpers/support.rb

@@ -1,19 +1,11 @@
 module SimpleHelpers
   class Support
-
-    def self.log(message)
-      Rails.logger.debug "SimpleHelpers => #{message}" if SimpleHelpers::Config.has_option? :log
-    end
-
     def self.certified_array!(splat_arg)
       array = splat_arg.first.is_a?(Array) ? splat_arg.first : Array(splat_arg)
       array.collect{|item| item.to_s}
     end
 
     def self.scopes(controller, method_name)
-      options = controller.send "#{method_name}_options"
-      return {:first => options[:scope]} if options.has_key? :scope
-
       controller_name = controller.class.name.underscore
       controller_name.gsub!(/\//, "_")
       controller_name.gsub!(/_controller$/, "")
@@ -25,7 +17,6 @@ module SimpleHelpers
         action_name = simple_helper_aliases.fetch(action_name, action_name) if simple_helper_aliases.is_a? Hash
       end
       group = method_name
-      group = group.pluralize if options.has_key? :pluralize
 
       {
         :first => "#{group}.#{controller_name}.#{action_name.to_s}",
@@ -33,47 +24,83 @@ module SimpleHelpers
       }
     end
 
+    def self.template(controller, context)
+      context.scan(/{{.*?}}/i).each do |key|
+        parts  = key.delete("{}").split(".")
+
+        begin
+          first_argument = parts.shift
+          if first_argument.start_with? "@"
+            instance_variable = controller.instance_variable_get(first_argument)
+
+            value = if parts.empty?
+                      instance_variable
+                    else
+                      thing = parts.shift.to_sym
+                      instance_variable[thing] if instance_variable.respond_to?(thing)
+                    end
+          else
+            value = controller.send first_argument
+          end
+          value = "" unless value
+        rescue
+          value = ""
+        ensure
+          context.sub!(key, value)
+        end
+      end
+      context
+    end
+
+    def self.translate(scope, options)
+      begin
+        _options = options || {}
+        I18n.translate!(scope, _options.merge({raise: true}))
+      rescue I18n::MissingTranslationData
+        ""
+      end
+    end
+
+    def self.get_content(scopes, options)
+      result = SimpleHelpers::Support.translate(scopes[:first], options)
+      if result.empty?
+        result = SimpleHelpers::Support.translate(scopes[:second], options)
+      end
+      result
+    end
+
     def self.create_method(controller, name)
       controller.class_eval do
         define_method(name) do |*args|
           if args.empty?
             send "#{name}_get"
           else
-            options = args.extract_options!
-            send "#{name}_set", args.first, options
+            send "#{name}_set", args.first
           end
         end
 
-        define_method("#{name}_options") do
-          instance_variable_set("@#{name}_options", {}) unless instance_variable_get("@#{name}_options")
-          instance_variable_get("@#{name}_options")
-        end
-
         define_method("#{name}_set") do |*args|
           instance_variable_set "@#{name}", args.first
-          instance_variable_set "@#{name}_options", args.last
         end
 
         define_method("#{name}_get") do |*args|
-          scopes      = SimpleHelpers::Support.scopes(controller, name)
-
-          value       = instance_variable_get("@#{name}")
-          options     = send("#{name}_options")
-
-          result      = value % options unless value.nil?
+          scopes         = SimpleHelpers::Support.scopes(controller, name)
+          options_hash   = instance_variable_get("@#{name}_options")
+          result         = SimpleHelpers::Support.get_content(scopes, options_hash)
+          helper_options = SimpleHelpers::Config.helpers[name.to_sym]
 
-          # removing rails reserved word
-          helper_options = options.delete_if{|k,v| k.to_sym == :scope}
+          prefix    = helper_options.fetch(:prefix, "")
+          content   = SimpleHelpers::Support.template(controller, result)
+          separator = if prefix.empty? || content.empty?
+                        ""
+                      else
+                        helper_options.fetch(:separator, " - ")
+                      end
 
-          result ||= t(scopes[:first], helper_options)
-          if result.include? "translation missing" and scopes.has_key? :second
-            helper_options.merge! :default => result
-            result = t(scopes[:second], helper_options)
-          end
-
-          result
+          "#{prefix}#{separator}#{content}"
         end
       end
     end
+
   end
 end

data/lib/simple_helpers/version.rb

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

data/lib/simple_helpers.rb

@@ -11,8 +11,6 @@ module SimpleHelpers
 end
 
 SimpleHelpers.configure do |config|
-  config.helpers = []
-  config.except  = []
-  config.only    = []
-  config.options = [:log]
+  config.helpers = {}
+  config.options = []
 end

data/templates/initializer.rb

@@ -1,23 +1,8 @@
-# Use this file to setup SimpleHelpers.
 require "simple_helpers"
 
 SimpleHelpers.configure do |config|
-  # Helper methods that will be automatically
-  # created in the controllers
-  # config.helpers   = [:page_title]
-
-  # config.helpers will NOT be created automatically in these controllers
-  # *** keep it empty if you would allow all controlers
-  # example: [SessionsController]
-  # config.except = []
-
-  # config.helpers will be created automatically in these controllers
-  # *** keep it empty if you would allow all controlers
-  # example: [PostsController]
-  # config.only = []
-
-  # Options:
-  # :pluralize => I18n pluralized helper names
-  # [ :log, :pluralize ]
-  # config.options = [ :log ]
+  # Helper methods that will be automatically created in the controllers
+  # config.helpers = {
+  #   page_title: { prefix: "MySite", separator: " - " }
+  # }
 end

metadata

@@ -1,78 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: simple_helpers
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 2.0.0.beta
 platform: ruby
 authors:
 - Vitor Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-10 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   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: rspec-rails
   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: 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: rake
   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: Customizable helper methods with I18n support.
@@ -111,33 +102,26 @@ files:
 - templates/initializer.rb
 homepage: http://rubygems.org/gems/simple_helpers
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2281090930503937938
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -2281090930503937938
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Customizable helper methods with I18n support.
 test_files:
 - spec/controllers/application_controller_spec.rb