RubyGems - goose - Versions diffs - 0.6.0 - Mend

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

data/.document +5 -0
data/.gitignore +21 -0
data/LICENSE +20 -0
data/README.md +100 -0
data/Rakefile +51 -0
data/VERSION +1 -0
data/lib/generators/goose/USAGE +4 -0
data/lib/generators/goose/install_generator.rb +18 -0
data/lib/generators/goose/templates/goose.rb +13 -0
data/lib/goose/config.rb +22 -0
data/lib/goose/ext/action_view.rb +2 -0
data/lib/goose/helper.rb +28 -0
data/lib/goose/state.rb +29 -0
data/lib/goose.rb +22 -0
data/test/helper.rb +10 -0
data/test/test_goose.rb +7 -0
metadata +81 -0

data/.document ADDED Viewed

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore ADDED Viewed

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+## TEXTMATE
+*.tmproj
+tmtags
+## EMACS
+*~
+\#*
+.\#*
+## VIM
+*.swp
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+## PROJECT::SPECIFIC

data/LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Bruce Williams
+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 ADDED Viewed

@@ -0,0 +1,100 @@
+Goose
+=====
+Goose is a navigation plugin for Rails whose aim it is to make adding
+smart, context-aware navigation to your application as easy as
+possible.
+Installing it
+-------------
+First of all, install it with bundler.
+In your `Gemfile`:
+    gem 'goose'
+Then:
+    $ bundle install
+Now, install the Goose configuration:
+    $ rails generate goose:install
+Adding your navigation
+----------------------
+Create a partial for each navigation menu in the [now present]
+`app/views/nav` directory.  You can have as many as you like.
+We add one in `app/views/nav/_main.html.erb`:
+    <nav>
+      <ul>
+      </ul>
+    </nav>
+You'll notice this example uses HTML5 `<nav>` tags.  You don't have to
+(but you probably should).
+In your `<ul>`, use `nav_to` in place of your `<li>`s.  `nav_to` is
+invoked the same way as the `link_to` helper you already know and love:
+    <nav>
+      <ul>
+        <%= nav_to 'People', people_path %>
+        <%= nav_to 'Places', places_path %>
+        <%= nav_to 'Things', things_path %>
+      </ul>
+    </nav>
+Now, in each action template, just tell Goose where you are.
+    <%= nav_at 'People' %>
+By default, Goose guesses your location is in reference to a `"main"`
+nav.  You can tell it to use something else easily enough; for
+instance, if we also had a `app/views/nav/_people.html.erb` that we
+were using as secondary navigation:
+    <%= nav_at 'Address Information', in: 'people' %>
+The navigation partial will be inserted (as you might expect), exactly
+where you put your `nav_at`.  If you want to place your navigation
+somewhere else (as you probably want to do with your main navigation),
+just wrap your navigation partial in a `content_for`:
+    <% content_for :main_navigation do %>
+      <nav>
+        <ul>
+          <%= nav_to 'People', people_path %>
+          <%= nav_to 'Places', places_path %>
+          <%= nav_to 'Things', things_path %>
+        </ul>
+      </nav>
+    <% end %>
+And use `yield` wherever it makes sense in your layout:
+    <!DOCTYPE html>
+    <html>
+      ...
+      <header>
+        <h1>Great balls of fire!</h1>
+        <%= yield :main_navigation %>
+      </header>
+      ...
+    </html>
+It's that simple.
+Customizing Goose
+-----------------
+See `config/initializers/goose.rb` for options.
+Copyright
+---------
+Copyright (c) 2010 Bruce Williams. See LICENSE for details.

data/Rakefile ADDED Viewed

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "goose"
+    gem.summary = %Q{Top Gun navigation for your Rails application}
+    gem.description = %Q{Flexible, simple support for multiple navigation views}
+    gem.email = "bruce@codefluency.com"
+    gem.homepage = "http://github.com/bruce/goose"
+    gem.authors = ["Bruce Williams"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+task :test => :check_dependencies
+task :default => :test
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "goose #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.6.0

data/lib/generators/goose/USAGE ADDED Viewed

@@ -0,0 +1,4 @@
+To copy a Goose initializer to your Rails App and create your
+app/views/nav directory, just do:
+    rails generate goose:install

data/lib/generators/goose/install_generator.rb ADDED Viewed

@@ -0,0 +1,18 @@
+module Goose
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy Goose default files"
+      source_root File.expand_path('../templates', __FILE__)
+      def copy_initializers
+        copy_file 'goose.rb', 'config/initializers/goose.rb'
+      end
+      def create_nav_directory
+        empty_directory "app/views/nav"
+        create_file "app/views/nav/.gitkeep", "\n"
+      end
+    end
+  end
+end

data/lib/generators/goose/templates/goose.rb ADDED Viewed

@@ -0,0 +1,13 @@
+# Use this setup block to configure all options available in Goose.
+Goose.setup do |config|
+  # Default tag used by nav_to
+  # config.wrapper_tag = :li
+  # Default options added to nav_to wrapper when current location
+  # config.active_options = {:class => 'active'}
+  # Default options added to nav_to wrapper when not current location
+  # config.inactive_options = {}
+end

data/lib/goose/config.rb ADDED Viewed

@@ -0,0 +1,22 @@
+module Goose
+  class Config
+    attr_writer :wrapper_tag, :active_options, :inactive_options
+    def wrapper_tag
+      @wrapper_tag ||= :li
+    end
+    def active_options
+      @active_options ||= {:class => 'active'}
+    end
+    def inactive_options
+      @inactive_options ||= {}
+    end
+  end
+end

data/lib/goose/ext/action_view.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require 'action_view'
2	+ ActionView::Base.send(:include, Goose::Helper)

data/lib/goose/helper.rb ADDED Viewed

@@ -0,0 +1,28 @@
+module Goose
+  module Helper
+    def goose
+      @goose ||= State.new(self)
+    end
+    def nav_to(place, url, options = {}, &block)
+      if goose.at?(place)
+        options.update(Goose.config.active_options)
+      end
+      content = link_to(place, url) if url
+      content_tag(Goose.config.wrapper_tag, content, options, &block)
+    end
+    def nav_at(place, options = {})
+      nav = options[:in] || :main
+      goose.render(nav, place)
+    end
+    def nav(name = nil)
+      nav_at(nil, :in => name)
+    end
+  end
+end

data/lib/goose/state.rb ADDED Viewed

@@ -0,0 +1,29 @@
+module Goose
+  class State
+    def initialize(view)
+      @view = view
+      @stack ||= []
+    end
+    def render(nav, place)
+      at(nav, place) { @view.render(:partial => "nav/#{nav}") }
+    end
+    def at?(place)
+      @stack.last == place
+    end
+    private
+    def at(nav, place, &block)
+      @stack << place
+      result = yield
+      @stack.pop
+      result
+    end
+  end
+end

data/lib/goose.rb ADDED Viewed

@@ -0,0 +1,22 @@
+module Goose
+  autoload :Config,  'goose/config'
+  autoload :Helper,  'goose/helper'
+  autoload :State,   'goose/state'
+  def self.config
+    @config ||= Config.new
+  end
+  def self.setup(&block)
+    yield config
+  end
+  # Not recommended for production use.
+  def self.eject! #:nodoc:
+    raise NotImplementedError, "BOOM...Crunch"
+  end
+end
+require 'goose/ext/action_view'

data/test/helper.rb ADDED Viewed

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'goose'
+class Test::Unit::TestCase
+end

data/test/test_goose.rb ADDED Viewed

@@ -0,0 +1,7 @@
+require 'helper'
+class TestGoose < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: goose
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
+platform: ruby
+authors:
+- Bruce Williams
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-11-03 00:00:00 -07:00
+default_executable:
+dependencies: []
+description: Flexible, simple support for multiple navigation views
+email: bruce@codefluency.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/generators/goose/USAGE
+- lib/generators/goose/install_generator.rb
+- lib/generators/goose/templates/goose.rb
+- lib/goose.rb
+- lib/goose/config.rb
+- lib/goose/ext/action_view.rb
+- lib/goose/helper.rb
+- lib/goose/state.rb
+- test/helper.rb
+- test/test_goose.rb
+has_rdoc: true
+homepage: http://github.com/bruce/goose
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Top Gun navigation for your Rails application
+test_files:
+- test/helper.rb
+- test/test_goose.rb

goose 0.6.0