trejo 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d7167dcc26e34868545129b750246edb2bd34df
+  data.tar.gz: aef5d381977f15648365cb1484031a10514b0735
+SHA512:
+  metadata.gz: f4570e03d3106449ecdcd6d19e44e2ab99b82ea409ae7a86511a5ad3346246c3a0af4239815f0f64954f17ca82cbe85421bf28763e8fdbcff25fcb2aaeb91fc5
+  data.tar.gz: 3a6dbb02b6adbf83178b8162bdf2b0a09b1c0808a06052bc94671f6bb0fe5388529a67b837f386d6fe4f20f5773a38d6ef4092be38cb5712278e9445ed08c84f

data/README.md

@@ -1,58 +1,184 @@
 # Trejo
 
-Trejo provides `nav_item` helper to render navigation links. An `active` class is applied to the link when the requested path matches the link url.
+Trejo provides view helpers and utilities for common UI needs in Rails apps.
 
 ## Installation
 
-Add it to your Gemfile and run the `bundle` command to install it.
+Add it to the Gemfile
 
- ```ruby
- gem 'trejo'
- ```
+```ruby
+gem 'trejo'
+```
+
+And run
+
+```
+bundle
+```
+
+Then run the installer to generate the initializer
+
+```
+$ rails g trejo:install
+```
+
+An initializer should now be at
+
+```
+config/initializers/trejo.rb
+```
+
+### Configuration parameters
+
+The initializer should look similar to the following
+
+```ruby
+Trejo.configure do |config|
+  config.site_title = 'My Website Title'
+  config.company_name = 'My Company Name'
+end
+```
+
+Set the values for the config params `site_title` and/or `company_name` as needed.
 
 ## Usage
 
-If the current path is `/home`, then the following
+### nav_item
 
- ```
- <nav>
-   <%= nav_item 'Home', '/home' %>
-   <%= nav_item 'Blog', '/blog' %>
- </nav>
- ```
+The `nav_item` helper renders a navigation link with `active` class when the requested path matches the link url.
 
-generates
+For example, if the current path is `/home`, then the following
 
- ```
- <nav>
-   <a href='/home' class='active'>Home</a>
-   <a href='/blog'>Blog</a>
- </nav>
- ```
+```erb
+<nav>
+  <%= nav_item 'Home', '/home' %>
+  <%= nav_item 'Blog', '/blog' %>
+</nav>
+```
 
-Trejo assumes that the link url is the root of the resource, and ignores query parameters by default. So the above example also works if the requested path is `/home/index?foo=bar`.
+renders
+
+```html
+<nav>
+  <a href='/home' class='active'>Home</a>
+  <a href='/blog'>Blog</a>
+</nav>
+```
+
+`nav_item` assumes that the link url is the root of the resource, and ignores query parameters by default. So the above example also works if the requested path is `/home/index?foo=bar`.
 
 The default css class applied to the link is `active`. This can be overridden by passing a `class` option with the desired class.
 
- ```
- <%= nav_item 'Home', '/home', class: 'current-section' %>
- ```
+```erb
+<%= nav_item 'Home', '/home', class: 'current-section' %>
+```
 
 generates
 
- ```
- <a href='/home' class='current-section'>Home</a>
- ```
+```html
+<a href='/home' class='current-section'>Home</a>
+```
 
 If you need more granularity in the criteria for determining an active link, you can supply a regular expression in the `selected ` option. So if the current path is `/home?foo=bar`, then the following
 
- ```
- <%= nav_item 'Home', '/home?foo=bar', selected: /^\/home\?foo=\w+/ %>
- ```
+```erb
+<%= nav_item 'Home', '/home?foo=bar', selected: /^\/home\?foo=\w+/ %>
+```
 
 generates
 
- ```
- <a class='active'>Home</a>
- ```
+```
+<a class='active'>Home</a>
+```
+
+### merge_classes
+
+The `merge_classes` helper takes any string or array or combination thereof to produce a string of css classes separated by a single whitespace.
+
+```ruby
+merge_classes 'foo', 'bar'                                   => 'foo bar'
+merge_classes 'foo bar', 'baz'                               => 'foo bar baz'
+merge_classes ['foo', 'bar'], 'baz'                          => 'foo bar baz'
+merge_classes ['walter', 'sobchak'], ['shomer', ['shabbas']] => 'walter sobchak shomer shabbas'
+```
+
+Whitespaces, duplicates and blank/nil values are omitted.
+
+### title
+
+`title` generates the title tag for the current page.
+
+In the application layout template, add the following
+
+```erb
+<title><%= yield(:title).presence %></title>
+```
+
+Then set the page title anywhere in the current page template
+
+```erb
+<%= title 'About Us' %>
+```
+
+which yields
+
+```html
+<title>About Us | My Website Title</title>
+```
+
+The website title defaults to the top level application module name. Set the config param `site_title` to customize this value.
+
+### copyright_notice
+
+```erb
+<%= copyright_notice 'My Company Name' %>
+```
+
+yields
+
+```html
+© 2015 My Company Name, All Rights Reserved
+```
+
+You can also call it without the company name
+
+```erb
+<%= copyright_notice %>
+```
+
+This defaults to the `company_name` config param, which itself defaults to the top level application module name.
+
+In `config/initializers/trejo.rb`,
+
+```ruby
+Trejo.configure do |config|
+  config.company_name = 'My Company Name'
+end
+```
+
+### page_id, page_class
+
+It's often useful to scope the current page's elements at the top level.
+
+On the `body` tag, usually in the application layout, add the following
+
+```erb
+<body id='<%= body_id %>' class='<%= body_class %>'>
+</body>
+```
+
+Then in the current template
+
+```erb
+<%= page_id 'body-tag-id' %>
+<%= page_class 'body-tag-class' %>
+```
+
+If `page_class` is not called, then no class is applied.
+
+If `page_id` is not called, then `body_id` outputs a dom id in the following format
+
+```ruby
+"#{controller_name}-#{action_name}-page".dasherize
+```
 

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,25 @@
+Trejo.configure do |config|
+  # Setting site_title to 'My Website Title' and calling:
+  #
+  #   title 'About Us'
+  #
+  # yields the title tag:
+  #
+  #   <title>About Us | My Website Title</title>
+  #
+  # Defaults to the top level application module name
+  #
+  # config.site_title = 'My Website Title'
+
+  # Setting company_name to 'Church of Scientautology, LLC' and calling:
+  #
+  #   copyright_notice
+  #
+  # yields the output text:
+  #
+  #   © 2015 Church of Scientautology, LLC, All Rights Reserved
+  #
+  # Defaults to the top level application module name
+  #
+  # config.company_name = 'Church of Scientautology, LLC'
+end

data/lib/generators/trejo/install_generator.rb

@@ -0,0 +1,12 @@
+module Trejo
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+      desc 'Creates Trejo initializer for your application'
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/trejo.rb'
+      end
+    end
+  end
+end

data/lib/trejo/version.rb

@@ -1,3 +1,3 @@
 module Trejo
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/trejo/view_helpers.rb

@@ -12,5 +12,40 @@ module Trejo
       link_class = options[:class] || 'active' if selected
       link_to name, url, class: link_class
     end
+
+    def merge_classes(*classes)
+      classes.flatten
+        .reject(&:blank?).map(&:split)
+        .flatten.uniq.join ' '
+    end
+
+    def title page_title
+      return if page_title.blank?
+      content_for(:title) { "#{page_title} | #{Trejo.configuration.site_title}" }
+    end
+
+    def body_id
+      if content_for?(:page_id)
+        content_for(:page_id)
+      else
+        "#{controller.controller_name}-#{controller.action_name}-page".dasherize
+      end
+    end
+
+    def body_class
+      content_for?(:page_class) ? content_for(:page_class) : nil
+    end
+
+    def page_id value
+      content_for(:page_id) { value }
+    end
+
+    def page_class value
+      content_for(:page_class) { value }
+    end
+
+    def copyright_notice company_name = nil
+      "\u00A9 #{Date.current.year} #{company_name.presence || Trejo.configuration.company_name}, All Rights Reserved"
+    end
   end
 end

data/lib/trejo.rb

@@ -1,2 +1,22 @@
 require 'trejo/version'
 require 'trejo/railtie' if defined?(Rails)
+
+module Trejo
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :site_title, :company_name
+
+    def initialize
+      @site_title   = Rails.application.class.parent_name
+      @company_name = Rails.application.class.parent_name
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 require 'action_view'
+require 'action_dispatch'
 require 'trejo/view_helpers'

data/spec/trejo/view_helpers_spec.rb

@@ -1,134 +1,181 @@
 require 'spec_helper'
 
 include ActionView::Helpers::UrlHelper
+include ActionDispatch
 class TrejoHelperTestClass; end
 
 describe Trejo::ViewHelpers do
+  let(:trejo) do
+    TrejoHelperTestClass.new
+  end
+
   before do
-    @trejo = TrejoHelperTestClass.new
-    @trejo.extend Trejo::ViewHelpers
+    trejo.extend Trejo::ViewHelpers
   end
 
   describe '#nav_item' do
+    let(:request) do
+      instance_double ActionDispatch::Request, fullpath: fullpath
+    end
+
+    before do
+      expect(trejo).to receive(:request).and_return(request)
+    end
+
     context 'by default' do
-      context 'when the link path matches the requested path' do
-        before do
-          request = stub fullpath: '/home'
-          @trejo.stub(:request).and_return(request)
+      let(:fullpath) { '/home' }
 
-          @nav_item = @trejo.nav_item('Home', '/home')
+      context 'when the link path matches the requested path' do
+        let(:nav_item) do
+          trejo.nav_item('Home', '/home')
         end
 
         it 'returns a selected nav item' do
-          expect(@nav_item).to eq('<a href="/home" class="active">Home</a>')
+          expect(nav_item).to eq('<a class="active" href="/home">Home</a>')
         end
       end
 
       context 'when the link path does not match the requested path' do
-        before do
-          request = stub fullpath: '/home'
-          @trejo.stub(:request).and_return(request)
-
-          @nav_item = @trejo.nav_item('Blog', '/blog')
+        let(:nav_item) do
+          trejo.nav_item('Blog', '/blog')
         end
 
         it 'returns an unselected nav item' do
-          expect(@nav_item).to eq('<a href="/blog">Blog</a>')
+          expect(nav_item).to eq('<a href="/blog">Blog</a>')
         end
       end
 
       context 'ignores query parameters' do
         context 'and when the link path matches the requested path' do
-          before do
-            request = stub fullpath: '/home?page=2'
-            @trejo.stub(:request).and_return(request)
+          let(:fullpath) { '/home?page=2' }
 
-            @nav_item = @trejo.nav_item('Home', '/home')
+          let(:nav_item) do
+            trejo.nav_item('Home', '/home')
           end
 
           it 'returns a selected nav item' do
-            expect(@nav_item).to eq('<a href="/home" class="active">Home</a>')
+            expect(nav_item).to eq('<a class="active" href="/home">Home</a>')
           end
         end
       end
 
       context 'assumes the link path is the root' do
         context 'and when the requested path includes a nested path' do
-          before do
-            request = stub fullpath: '/home/index'
-            @trejo.stub(:request).and_return(request)
-            @nav_item = @trejo.nav_item('Home', '/home')
+          let(:fullpath) { '/home/index' }
+
+          let(:nav_item) do
+            trejo.nav_item('Home', '/home')
           end
 
           it 'returns a selected nav item' do
-            expect(@nav_item).to eq('<a href="/home" class="active">Home</a>')
+            expect(nav_item).to eq('<a class="active" href="/home">Home</a>')
           end
         end
 
         context 'and when the requested path includes a different root path' do
-          before do
-            request = stub fullpath: '/blog/index'
-            @trejo.stub(:request).and_return(request)
-            @nav_item = @trejo.nav_item('Home', '/home')
+          let(:fullpath) { '/blog/index' }
+
+          let(:nav_item) do
+            trejo.nav_item('Home', '/home')
           end
 
           it 'returns an unselected nav item' do
-            expect(@nav_item).to eq('<a href="/home">Home</a>')
+            expect(nav_item).to eq('<a href="/home">Home</a>')
           end
         end
 
         context 'and when query parameters are present' do
-          before do
-            request = stub fullpath: '/home/index?foo=bar&walter=sobchak'
-            @trejo.stub(:request).and_return(request)
-            @nav_item = @trejo.nav_item('Home', '/home')
+          let(:fullpath) { '/home/index?foo=bar&walter=sobchak' }
+
+          let(:nav_item) do
+            trejo.nav_item('Home', '/home')
           end
 
           it 'returns a selected nav item' do
-            expect(@nav_item).to eq('<a href="/home" class="active">Home</a>')
+            expect(nav_item).to eq('<a class="active" href="/home">Home</a>')
           end
         end
       end
     end
 
     context 'when the selection criteria is a regex' do
-      before do
-        request = stub fullpath: '/home?page=2'
-        @trejo.stub(:request).and_return(request)
-      end
+      let(:fullpath) { '/home?page=2' }
 
       context 'when the requested path matches the criteria' do
-        before do
-          @nav_item = @trejo.nav_item('Home', '/home', selected: /^\/home/)
+        let(:nav_item) do
+          trejo.nav_item('Home', '/home', selected: /^\/home/)
         end
 
         it 'returns a selected nav item' do
-          expect(@nav_item).to eq('<a href="/home" class="active">Home</a>')
+          expect(nav_item).to eq('<a class="active" href="/home">Home</a>')
         end
       end
 
       context 'when the requested path does not match the criteria' do
-        before do
-          @nav_item = @trejo.nav_item('Blog', '/blog', selected: /^\/blog/)
+        let(:nav_item) do
+          trejo.nav_item('Blog', '/blog', selected: /^\/blog/)
         end
 
         it 'returns a unselected nav item' do
-          expect(@nav_item).to eq('<a href="/blog">Blog</a>')
+          expect(nav_item).to eq('<a href="/blog">Blog</a>')
         end
       end
     end
 
     context 'when a css class is supplied' do
-      before do
-        request = stub fullpath: '/home'
-        @trejo.stub(:request).and_return(request)
+      let(:fullpath) { '/home' }
 
-        @nav_item = @trejo.nav_item('Home', '/home', class: 'current-section')
+      let(:nav_item) do
+        trejo.nav_item('Home', '/home', class: 'current-section')
       end
 
       it 'returns a selected nav item with that class' do
-        expect(@nav_item).to eq('<a href="/home" class="current-section">Home</a>')
+        expect(nav_item).to eq('<a class="current-section" href="/home">Home</a>')
       end
     end
   end
+
+  describe '#merge_classes' do
+    it 'merges strings with strings' do
+      expect(trejo.merge_classes('foo', 'bar')).to eq('foo bar')
+      expect(trejo.merge_classes('foo bar', 'baz')).to eq('foo bar baz')
+    end
+
+    it 'merges arrays with strings' do
+      expect(trejo.merge_classes(['foo', 'bar'], 'baz')).to eq('foo bar baz')
+    end
+
+    it 'merges arrays with arrays' do
+      expect(
+        trejo.merge_classes(['walter', 'sobchak'], ['shomer', ['shabbas']])
+      ).to eq('walter sobchak shomer shabbas')
+    end
+
+    it 'omits duplicates' do
+      expect(
+        trejo.merge_classes(
+          'volta', 'cassandra gemini', 'volta', 'cygnus',
+          ['volta', 'vismund cygnus', 'cassandra', 'gemini']
+        )
+      ).to eq('volta cassandra gemini cygnus vismund')
+    end
+
+    it 'ignores blank values' do
+      expect(
+        trejo.merge_classes(
+          'volta', 'cassandra gemini', nil,
+          ['', 'cygnus', ' ', 'vismund', nil]
+        )
+      ).to eq('volta cassandra gemini cygnus vismund')
+    end
+
+    it 'strips unnecessary whitespaces' do
+      expect(
+        trejo.merge_classes(
+          ' volta ', 'cassandra      gemini ',
+          ['   cygnus', '  ', '         vismund ']
+        )
+      ).to eq('volta cassandra gemini cygnus vismund')
+    end
+  end
 end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: trejo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Boram Yoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-18 00:00:00.000000000 Z
+date: 2015-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   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
   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: Navigation links with active states based on current path
@@ -50,12 +45,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - CHANGELOG
 - Gemfile
 - README.md
 - Rakefile
+- lib/generators/templates/initializer.rb
+- lib/generators/trejo/install_generator.rb
 - lib/trejo.rb
 - lib/trejo/railtie.rb
 - lib/trejo/version.rb
@@ -65,27 +62,26 @@ files:
 - trejo.gemspec
 homepage: http://github.com/boram/trejo
 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: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: trejo
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Navigation link helper
 test_files:
 - spec/spec_helper.rb