rails_utils 3.3.1 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3569698ba27aae3cdcd88cb1ed58fc1d1e251b4
-  data.tar.gz: 229ea1766631a6d548e0056809dcc2cb576554df
+  metadata.gz: 569b976c686f0894cee61eab2b3e9bb6a734be81
+  data.tar.gz: 839e43dfd75277b580f921d9ab7636d3a64d0f6a
 SHA512:
-  metadata.gz: c50136816341a8e4cb2a36b9338d08186a702e044e7ff3b19784ea74a03e7e5c437dcd3a3f5e278364587e568ae3c03dddc0760dd8157b8cc3d673472487a3e5
-  data.tar.gz: 3abd2f3ed1de45d30e1f303957c6a97bb99d7bc52a99b5976be5bdb0b1c02057929fba92ed0d2b35e3584f1c3e68b2573e43e8a9f5cded1c595838ed2d0ce05d
+  metadata.gz: 17401582ef98f636428dc7cc835d31e92c5e24a6b711612a66c6126b4c695bc256ff489c14b2cd646ee24fd97458eb35bb8206d12bc69a42959083f017f5b053
+  data.tar.gz: 8dc65383216c2719a1c5e67c36b24d2de93a829ac9f9a76f2d5c06a1f307bea700dc7051e3adeec4aa2ea94c1bd4033c492c9e36fd4ae36b4b93b3ac31e94f51

data/README.md

@@ -4,7 +4,6 @@
 
 Rails helpers based on opinionated project practices. Currently useful for structuring CSS and JS.
 
-
 ## Installation
 
     gem install 'rails_utils'
@@ -56,7 +55,7 @@ becomes
 Besides, it supports I18n and interpolation:
 
     en:
-      anime:
+      animes:
         show:
           title: Showing anime of: %{anime_name}
 
@@ -117,64 +116,27 @@ You can also:
 - Add additional CSS classes to the alert with the `class` option.
 - Customize the close button with `button_html` and `button_class` options.
 
-## Contributing
-
-Pull Requests are very welcomed (with specs, of course)!
-
-Minitest-ed. To run all tests, just run `rake` or `rake test`.
-
-## Changelog
-
-_Version 3.3.1_
-
-- [Pull Request 10](https://github.com/winston/rails_utils/pull/10) - Allow overiding of `default` for `page_title` - by @choonkeat.
-
-_Version 3.3.0_
-
-- [Pull Request 8](https://github.com/winston/rails_utils/pull/8) - Add `button_html` and `button_class` options for `flash_messages` - by @choonkeat.
-- [Pull Request 9](https://github.com/winston/rails_utils/pull/9) - Remove `timedout` from `flash` that's specific to `Devise`.
-
-
-_Version 3.2.2_
-
-- [Pull Request 5](https://github.com/winston/rails_utils/pull/5) - Minor updates - by @JuanitoFatas.
-
-
-_Version 3.2.1_
+## Configuration
 
-- Update `page_title` to support I18n interpolation - by @JuanitoFatas.
+Override any of these defaults in `config/initializers/rails_utils.rb`
 
+```ruby
+RailsUtils.configure do |config|
+  config.selector_format = :underscored # or :hyphenated
+end
+```
 
-_Version 3.2.0_
-
-- Add `page_title` that supports I18n - by @huynhquancam.
-
-
-_Version 3.1.2_
-
-- Add `alert-danger` class to flash error messages for Bootstrap 3 support.
-
-
-_Version 3.1.1_
-
-- [Pull Request 1](https://github.com/winston/rails_utils/pull/2) Support for Rails 4.1.
-
-
-_Version 3.1.0_
-
-- Drop string `controller` from `page_class` and `javascript_initialization`.
-
+## Contributing
 
-_Version 3.0.0_
+Pull Requests are very welcomed (with specs, of course)!
 
-- Controller namespace added to `page_class` and `javascript_initialization`.
+Minitest-ed. To run all tests, just run `rake` or `rake test`.
 
 ## Author
 
 Rails Utils is maintained by [Winston Teo](mailto:winstonyw+rails_utils@gmail.com).
 
-[You should follow Winston on Twitter](http://www.twitter.com/winstonyw), or find out more on [WinstonYW](http://www.winstonyw.com) and [LinkedIn](http://sg.linkedin.com/in/winstonyw).
-
+[You should follow Winston on Twitter](https://www.twitter.com/winstonyw), or find out more on [WinstonYW](http://www.winstonyw.com) and [LinkedIn](http://sg.linkedin.com/in/winstonyw).
 
 ## License
 

data/lib/rails_utils/configuration.rb

@@ -0,0 +1,17 @@
+module RailsUtils
+  class Configuration
+    attr_accessor :selector_format
+
+    def initialize
+      @selector_format = :underscored
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/rails_utils/version.rb

@@ -1,3 +1,3 @@
 module RailsUtils
-  VERSION = "3.3.1"
+  VERSION = "3.3.2"
 end

data/lib/rails_utils.rb

@@ -1,9 +1,15 @@
+require 'rails_utils/configuration'
 require 'action_view'
 
 module RailsUtils
   module ActionViewExtensions
     def page_controller_class
-      controller.class.to_s.sub(/Controller$/, "").underscore.sub(/\//, "_")
+      case RailsUtils.configuration.selector_format.to_sym
+      when :hyphenated
+        page_controller_class_hyphenated
+      else # :underscored
+        page_controller_class_underscored
+      end
     end
 
     def page_action_class
@@ -21,14 +27,22 @@ module RailsUtils
       I18n.t("#{page_controller_class}.#{page_action_class}.title", i18n_options)
     end
 
-    def javascript_initialization
-      application_name = Rails.application.class.parent_name
+    def javascript_initialization(options = {})
+      application_name  = Rails.application.class.parent_name
+      js_namespace_name = page_controller_class_underscored
+      js_function_name  = page_action_class
+
+      if content_for?(:js_init_method)
+        js_custom_name = content_for(:js_init_method)
+        custom_js_init_method = "if(#{application_name}.#{js_namespace_name}.init_#{js_custom_name}) { #{application_name}.#{js_namespace_name}.init_#{js_custom_name}(); }"
+      end
 
       javascript_tag <<-JS
         #{application_name}.init();
-        if(#{application_name}.#{page_controller_class}) {
-          if(#{application_name}.#{page_controller_class}.init) { #{application_name}.#{page_controller_class}.init(); }
-          if(#{application_name}.#{page_controller_class}.init_#{page_action_class}) { #{application_name}.#{page_controller_class}.init_#{page_action_class}(); }
+        if(#{application_name}.#{js_namespace_name}) {
+          if(#{application_name}.#{js_namespace_name}.init) { #{application_name}.#{js_namespace_name}.init(); }
+          if(#{application_name}.#{js_namespace_name}.init_#{js_function_name}) { #{application_name}.#{js_namespace_name}.init_#{js_function_name}(); }
+          #{custom_js_init_method}
         }
       JS
     end
@@ -44,20 +58,28 @@ module RailsUtils
 
     private
 
-    def flash_class(key)
-      case key.to_sym
-        when :success
-          "alert alert-success"
-        when :notice
-          "alert alert-info"
-        when :error
-          "alert alert-danger alert-error"
-        when :alert
-          "alert alert-danger alert-error"
-        else
-          "alert alert-#{key}"
+      def flash_class(key)
+        case key.to_sym
+          when :success
+            "alert alert-success"
+          when :notice
+            "alert alert-info"
+          when :error
+            "alert alert-danger alert-error"
+          when :alert
+            "alert alert-danger alert-error"
+          else
+            "alert alert-#{key}"
+        end
+      end
+
+      def page_controller_class_hyphenated
+        page_controller_class_underscored.dasherize
+      end
+
+      def page_controller_class_underscored
+        controller.class.to_s.sub(/Controller$/, "").underscore.sub(/\//, "_")
       end
-    end
   end
 end
 

data/test/dummy/config/environments/development.rb

@@ -6,9 +6,6 @@ Dummy::Application.configure do
   # since you don't have to restart the web server when you make code changes.
   config.cache_classes = false
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
-
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
@@ -22,10 +19,12 @@ Dummy::Application.configure do
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
 
-
   # Do not compress assets
   config.assets.compress = false
 
   # Expands the lines which load the assets
   config.assets.debug = true
+
+  # Do not eager load code on boot.
+  config.eager_load = false
 end

data/test/dummy/config/environments/production.rb

@@ -61,4 +61,6 @@ Dummy::Application.configure do
   # Send deprecation notices to registered listeners
   config.active_support.deprecation = :notify
 
+  # Do not eager load code on boot.
+  config.eager_load = true
 end

data/test/dummy/config/environments/test.rb

@@ -11,9 +11,6 @@ Dummy::Application.configure do
   config.serve_static_assets = true
   config.static_cache_control = "public, max-age=3600"
 
-  # Log error messages when you accidentally call methods on nil
-  config.whiny_nils = true
-
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
@@ -29,7 +26,9 @@ Dummy::Application.configure do
   # ActionMailer::Base.deliveries array.
   config.action_mailer.delivery_method = :test
 
-
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
+
+  # Do not eager load code on boot.
+  config.eager_load = false
 end

data/test/rails_utils_test.rb

@@ -32,6 +32,40 @@ describe "RailsUtils::ActionViewExtensions" do
         view.page_controller_class.must_equal controller_name
       end
     end
+
+    describe "simple controller with hyphenated selector format" do
+      let(:controller_class) { "Awesome::AnimeController" }
+      let(:controller_name)  { "awesome-anime" }
+
+      before do
+        RailsUtils.configure do |config|
+          config.selector_format = :hyphenated
+        end
+
+        controller.stubs(:class).returns(controller_class)
+      end
+
+      it "returns controller name" do
+        view.page_controller_class.must_equal controller_name
+      end
+    end
+
+    describe "simple controller with specified selector format in string" do
+      let(:controller_class) { "Awesome::AnimeController" }
+      let(:controller_name)  { "awesome_anime" }
+
+      before do
+        RailsUtils.configure do |config|
+          config.selector_format = "underscored"
+        end
+
+        controller.stubs(:class).returns(controller_class)
+      end
+
+      it "returns controller name" do
+        view.page_controller_class.must_equal controller_name
+      end
+    end
   end
 
   describe "#page_action_class" do
@@ -149,6 +183,23 @@ describe "RailsUtils::ActionViewExtensions" do
         view.javascript_initialization.must_match "Dummy.#{controller_name}.init_edit();"
       end
     end
+
+    describe "with a content_for custom js_init_method as an argument" do
+      let(:action_name) { "update" }
+
+      it "uses the custom js init method" do
+        view.content_for(:js_init_method) { "custom" }
+        view.javascript_initialization.must_match "Dummy.#{controller_name}.init_custom();"
+      end
+    end
+
+    describe "without a content_for custom js_init_method as an argument" do
+      let(:action_name) { "update" }
+
+      it "does not generate an additional javascript method" do
+        view.javascript_initialization.wont_match "Dummy.#{controller_name}.init_();"
+      end
+    end
   end
 
   describe "#flash_messages" do
@@ -214,6 +265,5 @@ describe "RailsUtils::ActionViewExtensions" do
       set_flash :timedout, "not important"
       view.flash_messages.must_equal ""
     end
-
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_utils
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.3.2
 platform: ruby
 authors:
 - Winston Teo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2015-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -78,6 +78,7 @@ files:
 - README.md
 - Rakefile
 - lib/rails_utils.rb
+- lib/rails_utils/configuration.rb
 - lib/rails_utils/version.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile