live-front-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5dc31d13b1ac2ac3790da8c8a36fb9bedc294081
+  data.tar.gz: a45aa4c6f7589f15b5b498718cb755f747b5c9a2
+SHA512:
+  metadata.gz: 58e1c519b556b4cbb8b15a0834d98835d1bbba0a528c07371186aa66e5b7b8897eacdd5d40186cefd8b448568fd8f99d078f8c7c6cf3e777168be78dbed2c386
+  data.tar.gz: a922a58c81f7cc1c490f28c40ddfeba7bcfd4e7dac4a1459df86fd18db36819fb0832df860c0c11e57b547fa0a675c9525a9db381ebe5489fa12df6097f161c9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrey Krivko
+
+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,104 @@
+# Live Front
+
+Collection of useful helpers and workflows used at [Live Typing](http://ltst.ru).
+
+## List of helpers
+
+### TabHelper
+
+Navigation link helper. Returns an `li` element with an 'active' class if the supplied
+controller(s) and/or action(s) are currently active. The content of the
+element is the value passed to the block. Initially was copied from
+[GitLab project](https://gitlab.com/gitlab-org/gitlab-ce). Also it was added ability to specify
+`params` option to make link active when current path suits specified params.
+
+**options**
+
+The options hash used to determine if the element is "active" (default: {})
+
+`:controller`   - One or more controller names to check (optional).
+
+`:action`       - One or more action names to check (optional).
+
+`:path`         - A shorthand path, such as 'dashboard#index', to check (optional).
+
+`:params`       - One or more params to check. It also can be specified `:_blank` value to be able to specify either blank or non-blank param (optional).
+
+`:html_options` - Extra options to be passed to the list element (optional).
+
+**block**
+
+An optional block that will become the contents of the returned `li` element.
+
+When both `:controller` and `:action` are specified, BOTH must match in order
+to be marked as active. When only one is given, either can match.
+
+#### Examples:
+
+Assuming we're on `TreeController#show`
+
+```
+# Controller matches, but action doesn't
+nav_link(controller: [:tree, :refs], action: :edit) { "Hello" }
+# => '<li>Hello</li>'
+```
+
+```
+# Controller matches
+nav_link(controller: [:tree, :refs]) { "Hello" }
+# => '<li class="active">Hello</li>'
+```
+
+```
+# Shorthand path
+nav_link(path: 'tree#show') { "Hello" }
+# => '<li class="active">Hello</li>'
+```
+
+```
+# Supplying custom options for the list element
+nav_link(controller: :tree, html_options: {class: 'home'}) { "Hello" }
+# => '<li class="home active">Hello</li>'
+```
+
+```
+# Supplying params options when `params[:state] # => 'archived'`
+nav_link(path: 'tree#show', params: {state: 'archived'}) { "Hello" }
+# => '<li class="home active">Hello</li>'
+```
+
+```
+# Supplying params options when `params[:state] # => nil`
+nav_link(path: 'tree#show', params: {state: 'archived'}) { "Hello" }
+# => '<li class="home">Hello</li>'
+```
+
+```
+# Supplying params options when `params[:state] # => nil`
+nav_link(path: 'tree#show', params: {state: [:_blank, :active]}) { "Hello" }
+# => '<li class="home active">Hello</li>'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'live-front-rails', github: 'LiveTyping/live-front-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install live-front-rails
+
+## Contributing
+
+1. Fork it ( https://github.com/LiveTyping/live-front-rails/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
+end
+
+task default: :spec

data/lib/live-front-rails.rb

@@ -0,0 +1,14 @@
+require 'live-front/version'
+require 'live-front/application_helper'
+require 'live-front/tab_helper'
+
+module LiveFront
+  if defined?(Rails)
+    class Railtie < ::Rails::Railtie
+      initializer 'live_front.view_helpers' do
+        ActionView::Base.send :include, LiveFront::ApplicationHelper
+        ActionView::Base.send :include, LiveFront::TabHelper
+      end
+    end
+  end
+end

data/lib/live-front/application_helper.rb

@@ -0,0 +1,31 @@
+module LiveFront
+  module ApplicationHelper
+    # Check if a particular controller is the current one
+    #
+    # args - One or more controller names to check
+    #
+    # Examples
+    #
+    #   # On TreeController
+    #   current_controller?(:tree)           # => true
+    #   current_controller?(:commits)        # => false
+    #   current_controller?(:commits, :tree) # => true
+    def current_controller?(*args)
+      args.any? { |v| v.to_s.downcase == controller.controller_name }
+    end
+
+    # Check if a particular action is the current one
+    #
+    # args - One or more action names to check
+    #
+    # Examples
+    #
+    #   # On Projects#new
+    #   current_action?(:new)           # => true
+    #   current_action?(:create)        # => false
+    #   current_action?(:new, :create)  # => true
+    def current_action?(*args)
+      args.any? { |v| v.to_s.downcase == action_name }
+    end
+  end
+end

data/lib/live-front/tab_helper.rb

@@ -0,0 +1,102 @@
+module LiveFront
+  # Copied from GitLab project
+  # https://gitlab.com/gitlab-org/gitlab-ce
+  module TabHelper
+    # Navigation link helper
+    #
+    # Returns an `li` element with an 'active' class if the supplied
+    # controller(s) and/or action(s) are currently active. The content of the
+    # element is the value passed to the block.
+    #
+    # options - The options hash used to determine if the element is "active" (default: {})
+    #           :controller   - One or more controller names to check (optional).
+    #           :action       - One or more action names to check (optional).
+    #           :path         - A shorthand path, such as 'dashboard#index', to check (optional).
+    #           :html_options - Extra options to be passed to the list element (optional).
+    # block   - An optional block that will become the contents of the returned
+    #           `li` element.
+    #
+    # When both :controller and :action are specified, BOTH must match in order
+    # to be marked as active. When only one is given, either can match.
+    #
+    # Examples
+    #
+    #   # Assuming we're on TreeController#show
+    #
+    #   # Controller matches, but action doesn't
+    #   nav_link(controller: [:tree, :refs], action: :edit) { "Hello" }
+    #   # => '<li>Hello</li>'
+    #
+    #   # Controller matches
+    #   nav_link(controller: [:tree, :refs]) { "Hello" }
+    #   # => '<li class="active">Hello</li>'
+    #
+    #   # Shorthand path
+    #   nav_link(path: 'tree#show') { "Hello" }
+    #   # => '<li class="active">Hello</li>'
+    #
+    #   # Supplying custom options for the list element
+    #   nav_link(controller: :tree, html_options: {class: 'home'}) { "Hello" }
+    #   # => '<li class="home active">Hello</li>'
+    #
+    # Returns a list item element String
+    def nav_link(options = {}, &block)
+      c, a = fetch_controller_and_action(options)
+      p = options.delete(:params) || {}
+
+      klass = page_active?(c, a, p) ? 'active' : ''
+
+
+      # Add our custom class into the html_options, which may or may not exist
+      # and which may or may not already have a :class key
+      o = options.delete(:html_options) || {}
+      o[:class] = "#{o[:class]} #{klass}".strip
+
+      if block_given?
+        content_tag(:li, capture(&block), o)
+      else
+        content_tag(:li, nil, o)
+      end
+    end
+
+    private
+
+    def fetch_controller_and_action(options)
+      path = options.delete(:path)
+
+      if path
+        if path.respond_to?(:each)
+          c = path.map { |p| p.split('#').first }
+          a = path.map { |p| p.split('#').last }
+        else
+          c, a, _ = path.split('#')
+        end
+      else
+        c = options.delete(:controller)
+        a = options.delete(:action)
+      end
+      [c, a]
+    end
+
+    def page_active?(controller, action, parameters = {})
+      match_action_controller = if controller && action
+                                  # When given both options, make sure BOTH are active
+                                  current_controller?(*controller) && current_action?(*action)
+                                else
+                                  # Otherwise check EITHER option
+                                  current_controller?(*controller) || current_action?(*action)
+                                end
+
+      match_action_controller && match_params?(parameters)
+    end
+
+    def match_params?(parameters)
+      return true if parameters.empty?
+
+      parameters.all? do |key, value|
+        value = *value
+        value.any? { |v| v == :_blank ? params[key].to_s.blank? : v.to_s == params[key].to_s  }
+      end
+    end
+  end
+end

data/lib/live-front/version.rb

@@ -0,0 +1,3 @@
+module LiveFront
+  VERSION = '0.1.0'.freeze
+end

data/live-front-rails.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+require File.expand_path('../lib/live-front/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'live-front-rails'
+  spec.version       = LiveFront::VERSION
+  spec.authors       = ['Andrey Krivko']
+  spec.email         = ['jastkand@gmail.com']
+  spec.summary       = 'Useful helpers used at Live Typing'
+  spec.description   = 'Useful helpers used at Live Typing'
+  spec.homepage      = 'https://github.com/LiveTyping/live-front-rails'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails', '~> 4.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+  spec.add_development_dependency 'rspec-mocks', '~> 3.1.0'
+end

data/spec/helpers/tab_helper_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe LiveFront::TabHelper do
+  describe '#nav_link' do
+    before do
+      allow(self).to receive(:action_name).and_return('foo')
+    end
+
+    it 'captures block output' do
+      expect(nav_link { 'Testing Blocks' }).to match(/Testing Blocks/)
+    end
+
+    it 'performs checks on the current controller' do
+      expect(nav_link(controller: :foo)).to match(/<li class="active">/)
+      expect(nav_link(controller: :bar)).not_to match(/active/)
+      expect(nav_link(controller: [:foo, :bar])).to match(/active/)
+    end
+
+    it 'performs checks on the current action' do
+      expect(nav_link(action: :foo)).to match(/<li class="active">/)
+      expect(nav_link(action: :bar)).not_to match(/active/)
+      expect(nav_link(action: [:foo, :bar])).to match(/active/)
+    end
+
+    it 'performs checks on both controller and action when both are present' do
+      expect(nav_link(controller: :bar, action: :foo)).not_to match(/active/)
+      expect(nav_link(controller: :foo, action: :bar)).not_to match(/active/)
+      expect(nav_link(controller: :foo, action: :foo)).to match(/active/)
+    end
+
+    it 'accepts a path shorthand' do
+      expect(nav_link(path: 'foo#bar')).not_to match(/active/)
+      expect(nav_link(path: 'foo#foo')).to match(/active/)
+    end
+
+    it 'accepts a params value and checks if they are correct' do
+      expect(nav_link(path: 'foo#foo', params: { p1: :s1 })).to match(/active/)
+      expect(nav_link(path: 'foo#foo', params: { p2: [:_blank, :s2] })).to match(/active/)
+      expect(nav_link(path: 'foo#foo', params: { p2: :s1 })).not_to match(/active/)
+    end
+
+    it 'passes extra html options to the list element' do
+      expect(
+        nav_link(action: :foo, html_options: { class: 'home' })
+      ).to match(/<li class="home active">/)
+      expect(nav_link(html_options: { class: 'active' })).to match(/<li class="active">/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'active_support'
+require 'action_view'
+require 'action_controller'
+
+require 'live-front-rails'
+
+include ActionView::Context
+include ActionView::Helpers::FormTagHelper
+include LiveFront::ApplicationHelper
+include LiveFront::TabHelper
+
+class FooController < ActionController::Base
+  def foo
+  end
+end
+
+def controller
+  FooController.new
+end
+
+def params
+  ActionController::Parameters.new p1: 's1'
+end
+
+require 'rspec/core'
+require 'rspec/mocks'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: live-front-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Krivko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Useful helpers used at Live Typing
+email:
+- jastkand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/live-front-rails.rb
+- lib/live-front/application_helper.rb
+- lib/live-front/tab_helper.rb
+- lib/live-front/version.rb
+- live-front-rails.gemspec
+- spec/helpers/tab_helper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/LiveTyping/live-front-rails
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Useful helpers used at Live Typing
+test_files:
+- spec/helpers/tab_helper_spec.rb
+- spec/spec_helper.rb