activated_ui 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzAwMjE3ODFkN2M3ZmIwZmEzNjcxNjJjMTE4YjIxNDk1M2NhOTg5OQ==
+  data.tar.gz: !binary |-
+    NDA4OTdhZGVhODAxNWEwYWJlMmYxZGFlYTk1NTllZTBiNDFmMDM1Yg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODk1MGQ2NzRjNjBjODVmNDU2MDQzMmQ4MzM2NzY5ODZjZTZkZDY4YzM5YjRk
+    OTM3ODhmNGQ2YzRlMWM0ZDRlNjYyZWIyMGNkODFkYzVlMThhM2FkNmNmYWI2
+    ODI2YTFmMTA5NDMxM2QxM2VmYTExMTBmZDBmN2M5ZWNmNzk0OGI=
+  data.tar.gz: !binary |-
+    NjJhNzVlZjE4OGI5YjE0YjFlMjhmMWMzNmIzYmQ1NWM2ZjM0NWI1YmQ2OGVi
+    M2M0ZmQwNThiY2U4M2UwOWYxMDJiYjIyNGEyNjczNGU5NTY4YmI1OWEwZWEy
+    NWVlMGUzZWY1ZTY5MzY4ZDc5ZWM5ODQ1NmFjN2Y4NGNmOGRmZDk=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,87 @@
+# ActivatedUI
+
+ActivatedUI, is a collection of helpers to set and manage the active state of UI elements. It is similar to [active\_link\_to](https://github.com/twg/active_link_to) in that it is designed to help control the active state of UI elements for you. However where active\_link\_to infers the active state from the current url, ActivatedUI enables you to explicitly state it.
+
+
+## Installation
+
+When installing for Rails 3 applications add this to the Gemfile: `gem 'activated_ui'` and run `bundle install`.
+
+ActivatedUI _should_ work without rails, but I have to admit I haven't really used it in this environment.
+
+## Usage
+
+### Setting the Active State
+
+You can define the active state with:
+
+    activate_ui_marked :my_key # active state is [:my_key]
+
+You can give it as many keys at a time as you like:
+
+    activate_ui_marked :my_key, :another_key # active state is [:my_key, :another_key]
+
+`activate_ui_marked` builds on itself like so:
+
+    activate_ui_marked :my_key # active state is [:my_key]
+    activate_ui_marked :another_key # active state is now [:my_key, :another_key]
+
+### Getting the Active State
+
+Once you have set the active state there are a number of ways you can use it:
+
+Find if a key is active:
+
+    ui_activated? :my_key # will return true if :my_key is in the active state
+    ui_activated :my_key # ui_activated? is aliased to ui_activated if you so prefer
+
+Find if multiple keys are active:
+
+    ui_activated? :my_key, :another_key # will return true if all of the arguments are in the active state
+
+Get a html active class value:
+
+    <li class='<%= activated_class :my_key %>'>My Item</li> <!-- will produce class='active' if :my_key is in the active state otherwise class='' -->
+
+By default the returned class is 'active', but you can change this:
+
+    self.class.activated_class 'my_active_class'
+    activated_class :key # will now return 'my_active_class'
+
+## With Rails
+
+ActivatedUI isn't dependant on Rails but if you are using it with Rails here's how:
+
+    class PostsController < ActionController::Base
+
+      include ActivatedUI
+
+      activate_ui_marked :posts # Adds :key to the active state using a call to before_filter
+      activate_ui_marked :posts, :only => [:show] # It will pass on any options, so you can use before_filter's :only and :except options
+
+      activated_class 'my_custom_active_class' # Change the return value of activated_class :key
+
+      def show
+        activate_ui_marked :show
+        # show.html.erb
+      end
+
+    end
+
+
+Activated UI will add activated\_class, activate\_ui\_marked, stored\_activated_ui, ui\_activated? and ui\_activated as view helpers:
+
+    <% if ui_activated? :posts %>
+      <ul>
+         <li class='<%= activated_class :show %>'><%= activated_link_to :show, "Show Posts", post_path(@post), class: 'btn' %></li>
+      </ul>
+    <% end %>
+
+It will also add a helper to wrap Rail's `link_to`:
+
+    <%= activated_link_to :show, "Show Posts", post_path(@post), class: 'btn' %>
+
+It behaves the same way as `link_to` except there is an additional first argument that takes either a single key or an array of keys to check the active state with using `ui_activated?`. The active class is added to any classes you pass into via the options argument.
+
+
+

data/lib/activated_ui.rb

@@ -0,0 +1,61 @@
+module ActivatedUI
+
+  def self.included(base)
+
+    # If the module is being included on a an Rails controller
+    if defined?(ActionController::Base) && (base < ActionController::Base)
+
+      base.helper_method :activated_class, :activate_ui_marked, :stored_activated_ui, :ui_activated, :ui_activated?
+
+      def base.activate_ui_marked *refs
+        params = refs.last.is_a?(Array) ? refs.pop : {}
+        before_filter params do
+          activate_ui_marked *refs
+        end
+      end
+
+      if defined?(ActionView::Base)
+        ActionView::Base.send :include, ActivatedUI::Helpers
+      end
+
+    end
+
+    def base.activated_class value=nil
+      @activated_class = value unless value.nil?
+      @activated_class || 'active'
+    end
+
+  end
+
+
+  def activated_class *refs
+    if ui_activated? *refs
+      self.class.activated_class
+    else
+      ""
+    end
+  end
+
+  def activate_ui_marked *refs
+    refs.each do |ref|
+      stored_activated_ui << ref
+    end
+    stored_activated_ui
+  end
+
+  def stored_activated_ui
+    @stored_activated_ui ||= []
+  end
+
+  def ui_activated? *refs
+    all_match = true
+    refs.each do |ref|
+      all_match &&= stored_activated_ui.include?(ref)
+    end
+    all_match
+  end
+  alias :ui_activated :ui_activated?
+
+end
+
+require 'activated_ui/helpers'

data/lib/activated_ui/helpers.rb

@@ -0,0 +1,13 @@
+module ActivatedUI
+
+  module Helpers
+
+    def activated_link_to refs, name, url, link_options={}
+      refs = [refs] if refs.is_a? Symbol # If we're given a symbol make it an array
+      link_options[:class] = "#{link_options[:class]} #{activated_class(*refs)}".strip
+      link_to(name, url, link_options)
+    end
+
+  end
+
+end

data/lib/activated_ui/version.rb

@@ -0,0 +1,3 @@
+module ActivatedUI
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'spork'
+require 'rails/all'
+
+#uncomment the following line to use spork with the debugger
+# require 'spork/ext/ruby-debug'
+
+# @todo @dry this is repeated across the three projects
+Spork.prefork do
+  # This file is copied to spec/ when you run 'rails generate rspec:install'
+  ENV["RAILS_ENV"] ||= 'test'
+
+  require 'rspec/rails'
+  require 'rspec/autorun'
+
+  RSpec.configure do |config|
+
+    RESERVED_IVARS = %w(@loaded_fixtures)
+
+    # ## Mock Framework
+    #
+    # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+    #
+    # config.mock_with :mocha
+    # config.mock_with :flexmock
+    # config.mock_with :rr
+
+    # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+    config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+    # If you're not using ActiveRecord, or you'd prefer not to run each of your
+    # examples within a transaction, remove the following line or assign false
+    # instead of true.
+    # config.use_transactional_fixtures = true
+
+    # If true, the base class of anonymous controllers will be inferred
+    # automatically. This will be the default behavior in future versions of
+    # rspec-rails.
+    config.infer_base_class_for_anonymous_controllers = false
+
+    # Run specs in random order to surface order dependencies. If you find an
+    # order dependency and want to debug it, you can fix the order by providing
+    # the seed, which is printed after each run.
+    #     --seed 1234
+    config.order = "random"
+
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  end
+
+  ActiveSupport::Dependencies.clear
+
+end
+
+Spork.each_run do
+  
+  load File.dirname(__FILE__) + "/../lib/activated_ui.rb"
+
+end
+

data/spec/unit/activated_ui/activate_ui_marked_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe ActivatedUI do
+
+  include ActivatedUI
+
+  describe '#activate_ui_marked' do
+
+    it "adds a single passed symbol into stored_activated_ui" do
+      activate_ui_marked :a_symbol
+      stored_activated_ui.should eq [:a_symbol]
+    end
+
+    it "adds a multiple arguments" do
+      activate_ui_marked :a_symbol, :another_symbol, :and_another
+      stored_activated_ui.should eq [:a_symbol, :another_symbol, :and_another]
+    end
+
+    it "stacks values onto existing values" do
+      activate_ui_marked :a_symbol
+      activate_ui_marked :another_symbol
+      activate_ui_marked :and_another
+      stored_activated_ui.should eq [:a_symbol, :another_symbol, :and_another]
+    end
+
+    it "returns stored_activated_ui" do
+      returned_value = stored_activated_ui
+      activate_ui_marked(:something).should be returned_value
+    end
+
+  end
+
+end

data/spec/unit/activated_ui/activated_class_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe ActivatedUI do
+
+  include ActivatedUI
+
+  describe '#activated_class' do
+
+    context "when the ui is activated" do
+
+      before :each do
+        should_receive(:ui_activated?).with(:a_symbol).and_return(true)
+      end
+
+      it "return the configured active class" do
+        self.class.activated_class "my_active_class"
+        activated_class(:a_symbol).should eq "my_active_class"
+      end
+
+      it "returns 'active' if there isn't a configured class" do
+        self.class.activated_class false # Giving it false returns to default
+        activated_class(:a_symbol).should eq "active"
+      end
+
+    end
+
+    context "when the ui isn't activated" do
+
+      before :each do
+        should_receive(:ui_activated?).with(:not_the_symbol).and_return(false)
+      end
+
+      it "returns an empty string" do
+        activated_class(:not_the_symbol).should eq ""
+      end
+
+    end
+
+  end
+
+end

data/spec/unit/activated_ui/helpers/activated_link_to_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe ActivatedUI::Helpers do
+
+  include ActionView::Helpers::UrlHelper
+  include ActionView::Helpers::TagHelper
+  include ActivatedUI
+  include ActivatedUI::Helpers
+
+  describe '#activated_link_to' do
+
+    context "when the ui is activated" do
+
+      before :each do
+        should_receive(:ui_activated?).with(:a_symbol).and_return(true)
+      end
+
+      it "returns a link with a custom active class" do
+        self.class.activated_class "my_active_class"
+        activated_link_to(:a_symbol, "Link text", 'http://example.com').should eq '<a href="http://example.com" class="my_active_class">Link text</a>'
+      end
+
+      it "returns a link with 'active' class if there isn't a configured class" do
+        self.class.activated_class false # Giving it false returns to default
+        activated_link_to(:a_symbol, "Link text", 'http://example.com').should eq '<a href="http://example.com" class="active">Link text</a>'
+      end
+
+      it "gives additional arguments to link_to" do
+        link_text, link_url, link_options = "Link text", "http://example.com", { :class => "my_class" }
+        should_receive(:link_to).with(link_text, link_url, link_options)
+        activated_link_to(:a_symbol, link_text, link_url, link_options)
+      end
+
+      it "adds the active class to link_to's options" do
+        self.class.activated_class false # Giving it false returns to default
+        link_text, link_url, link_options = "Link text", "http://example.com", { :class => "my_class" }
+        should_receive(:link_to).with(link_text, link_url, { :class => "my_class active" })
+        activated_link_to(:a_symbol, link_text, link_url, link_options)
+      end
+
+      it "handles no provided class" do
+        self.class.activated_class false # Giving it false returns to default
+        link_text, link_url, link_options = "Link text", "http://example.com", { }
+        should_receive(:link_to).with(link_text, link_url, { :class => "active" })
+        activated_link_to(:a_symbol, link_text, link_url, link_options)
+      end
+
+    end
+
+    context "when the ui isn't activated" do
+
+      before :each do
+        should_receive(:ui_activated?).with(:not_the_symbol).and_return(false)
+      end
+
+      it "returns a link with no addition to the class" do
+        self.class.activated_class false # Giving it false returns to default
+        activated_link_to(:not_the_symbol, "Link text", 'http://example.com').should eq '<a href="http://example.com" class="">Link text</a>'
+      end
+
+    end
+
+  end
+
+end

data/spec/unit/activated_ui/included_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+class MockActivatedUIController < ActionController::Base
+  include ActivatedUI
+end
+
+describe ActivatedUI do
+
+
+  describe 'self.activated_class' do
+
+    subject { MockActivatedUIController }
+
+    it "adds activated_class class method to set and get active class" do
+      subject.activated_class.should eq 'active'
+      subject.activated_class('my_active').should eq 'my_active'
+      subject.activated_class.should eq 'my_active'
+      subject.activated_class(false).should eq 'active'
+      subject.activated_class.should eq 'active'
+    end
+
+  end
+
+  describe 'helper methods' do
+
+    it "sets some of its methods as view helpers" do
+      class MockActivatedUIController2 < ActionController::Base ; end
+      MockActivatedUIController2.should_receive(:helper_method).with(:activated_class, :activate_ui_marked, :stored_activated_ui, :ui_activated, :ui_activated?)
+      class MockActivatedUIController2 < ActionController::Base
+        include ActivatedUI
+      end
+    end
+
+    it "adds ActivatedUI::Helpers to ActionView::Base" do
+      ActionView::Base.should_receive(:include).with(ActivatedUI::Helpers)
+      class MockActivatedUIController3 < ActionController::Base
+        include ActivatedUI
+      end
+    end
+
+    it "doesn't add ActivatedUI::Helpers to ActionView::Base if its not ActionController::Base" do
+      ActionView::Base.should_not_receive(:include).with(ActivatedUI::Helpers)
+      class MockActivatedUIController4
+        include ActivatedUI
+      end
+    end
+
+  end
+
+end

data/spec/unit/activated_ui/stored_activated_ui_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe ActivatedUI do
+
+  include ActivatedUI
+
+  describe '#stored_activated_ui' do
+
+    it "returns an empty array if @stored_activated_ui is not yet set" do
+      stored_activated_ui.should eq []
+    end
+
+    it "returns an @stored_activated_ui if its been set" do
+      returned_value = stored_activated_ui
+      stored_activated_ui.should be returned_value
+    end
+
+  end
+
+end

data/spec/unit/activated_ui/ui_activated_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe ActivatedUI do
+
+  include ActivatedUI
+
+  describe '#ui_activated?' do
+
+    before :each do
+      should_receive(:stored_activated_ui).at_least(:once).and_return([:a, :b, :c])
+    end
+
+    it "returns true if the provided key is present in #stored_activated_ui" do
+      ui_activated?(:a).should be_true
+    end
+
+    it "returns false if the provided keys isn't present in #stored_activated_ui" do
+      ui_activated?(:d).should be_false
+    end
+
+    it "returns false if none of the provided keys are present in #stored_activated_ui" do
+      ui_activated?(:d, :e).should be_false
+    end
+
+    it "returns false if not all of the provided keys are present in #stored_activated_ui" do
+      ui_activated?(:a, :d).should be_false
+    end
+
+    it "returns true if the provided key is present in #stored_activated_ui" do
+      ui_activated?(:a).should be_true
+    end
+
+    it "returns true if all the provided key are present in #stored_activated_ui" do
+      ui_activated?(:a, :b).should be_true
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: activated_ui
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Spence
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spork-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Activated UI, is a collection of helpers to activate UI elements, it
+  achieves a similar end goal to active_link_to but you control the active state through
+  method calls rather than the helpers inferring it from the url.
+email:
+- msaspence@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/activated_ui/helpers.rb
+- lib/activated_ui/version.rb
+- lib/activated_ui.rb
+- MIT-LICENSE
+- README.md
+- spec/spec_helper.rb
+- spec/unit/activated_ui/activate_ui_marked_spec.rb
+- spec/unit/activated_ui/activated_class_spec.rb
+- spec/unit/activated_ui/helpers/activated_link_to_spec.rb
+- spec/unit/activated_ui/included_spec.rb
+- spec/unit/activated_ui/stored_activated_ui_spec.rb
+- spec/unit/activated_ui/ui_activated_spec.rb
+homepage: http://github.com/msaspence/activated_ui
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Activated UI, is a collection of helpers to activate UI elements.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/activated_ui/activate_ui_marked_spec.rb
+- spec/unit/activated_ui/activated_class_spec.rb
+- spec/unit/activated_ui/helpers/activated_link_to_spec.rb
+- spec/unit/activated_ui/included_spec.rb
+- spec/unit/activated_ui/stored_activated_ui_spec.rb
+- spec/unit/activated_ui/ui_activated_spec.rb