RubyGems - navigasmic - Versions diffs - 0.5.6 → 1.0.0 - Mend

navigasmic 0.5.6 → 1.0.0

Files changed (57) hide show

data/LICENSE +7 -1
data/lib/generators/navigasmic/install/POST_INSTALL +6 -0
data/lib/generators/navigasmic/install/install_generator.rb +17 -0
data/lib/generators/navigasmic/install/templates/initializer.rb +145 -0
data/lib/navigasmic.rb +5 -146
data/lib/navigasmic/builders/crumb_builder.rb +20 -0
data/lib/navigasmic/builders/list_builder.rb +90 -0
data/lib/navigasmic/builders/map_builder.rb +77 -0
data/lib/navigasmic/core/builders.rb +109 -0
data/lib/navigasmic/core/configuration.rb +38 -0
data/lib/navigasmic/core/item.rb +66 -0
data/lib/navigasmic/rails.rb +2 -0
data/lib/navigasmic/rails/engine.rb +9 -0
data/lib/navigasmic/rails/view_helpers.rb +18 -0
data/lib/navigasmic/version.rb +3 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/controllers/application_controller.rb +13 -0
data/spec/dummy/app/controllers/blog/links_controller.rb +7 -0
data/spec/dummy/app/controllers/blog/posts_controller.rb +7 -0
data/spec/dummy/app/views/application/welcome.html.erb +4 -0
data/spec/dummy/app/views/application/welcome.xml.builder +2 -0
data/spec/dummy/app/views/blog/links/index.html +4 -0
data/spec/dummy/app/views/blog/links/show.html +4 -0
data/spec/dummy/app/views/blog/posts/index.html +4 -0
data/spec/dummy/app/views/blog/posts/show.html +4 -0
data/spec/dummy/app/views/layouts/_navigation.html.erb +73 -0
data/spec/dummy/app/views/layouts/application.html.erb +40 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +57 -0
data/spec/dummy/config/boot.rb +9 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/test.rb +37 -0
data/spec/dummy/config/evergreen.rb +47 -0
data/spec/dummy/config/initializers/additional_navigasmic.rb +14 -0
data/spec/dummy/config/initializers/navigasmic.rb +145 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +68 -0
data/spec/dummy/log/.gitkeep +0 -0
data/spec/dummy/public/bootstrap.min.css +9 -0
data/spec/dummy/public/bootstrap.min.js +6 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/public/jquery.min.js +2 -0
data/spec/dummy/script/rails +6 -0
data/spec/spec_helper.rb +39 -0
metadata +139 -63
data/.document +0 -5
data/README.textile +0 -276
data/Rakefile +0 -57
data/VERSION +0 -1
data/lib/builders/html_builder.rb +0 -69
data/lib/builders/xml_builder.rb +0 -51
data/navigasmic.gemspec +0 -49
data/test/navigasmic_test.rb +0 -7
data/test/test_helper.rb +0 -10

data/spec/dummy/app/views/layouts/application.html.erb ADDED Viewed

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Navigasmic: Regression Test</title>
+    <link rel="stylesheet" type="text/css" href="/bootstrap.min.css"/>
+    <script type="text/javascript" src="/jquery.min.js"></script>
+    <script type="text/javascript" src="/bootstrap.min.js"></script>
+    <style>
+      .foo {
+        color: #0f0;
+      }
+      .foo a {
+        color: #0f0;
+      }
+      li.disabled {
+        color: #999;
+      }
+      .active {
+        color: #f00;
+      }
+      .active a {
+        color: #f00;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="navbar">
+      <div class="navbar-inner">
+        <a class="brand" href="/">Title</a>
+        <%= semantic_navigation :testing, config: :bootstrap %>
+      </div>
+    </div>
+    <%= yield %>
+    <%= render partial: 'layouts/navigation' %>
+  </body>
+</html>

data/spec/dummy/config.ru ADDED Viewed

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb ADDED Viewed

@@ -0,0 +1,57 @@
+require File.expand_path('../boot', __FILE__)
+require 'action_controller/railtie'
+require 'navigasmic'
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+    # Enable escaping HTML in JSON.
+    #config.active_support.escape_html_entities_in_json = true
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    #config.active_record.schema_format = :sql
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    #config.active_record.whitelist_attributes = true
+    # Enable the asset pipeline
+    #config.assets.enabled = true
+    # Version of your assets, change this if you want to expire all your assets
+    #config.assets.version = '1.0'
+  end
+end

data/spec/dummy/config/boot.rb ADDED Viewed

@@ -0,0 +1,9 @@
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb ADDED Viewed

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # 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
+  # Don't care if the mailer can't send
+  #config.action_mailer.raise_delivery_errors = false
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+  # Raise exception on mass assignment protection for Active Record models
+  #config.active_record.mass_assignment_sanitizer = :strict
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  #config.active_record.auto_explain_threshold_in_seconds = 0.5
+  # Do not compress assets
+  #config.assets.compress = false
+  # Expands the lines which load the assets
+  #config.assets.debug = true
+end

data/spec/dummy/config/environments/test.rb ADDED Viewed

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+  # Configure static asset server for tests with Cache-Control for performance
+  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
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  #config.action_mailer.delivery_method = :test
+  # Raise exception on mass assignment protection for Active Record models
+  #config.active_record.mass_assignment_sanitizer = :strict
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/evergreen.rb ADDED Viewed

@@ -0,0 +1,47 @@
+# The following allows us to have a nested directory structure of specs.  With
+# a lot of specs this is needed.
+Evergreen.configure do |config|
+  config.root = Temporal::Engine.root
+end
+module Evergreen
+  class Suite
+    def specs
+      Dir.glob(File.join(root, Evergreen.spec_dir, '**', '*_spec.{js,coffee,js.coffee}')).map do |path|
+        Spec.new(self, path.gsub(File.join(root), ''))
+      end
+    end
+    def templates
+      Dir.glob(File.join(root, Evergreen.template_dir, '**', '*')).map do |path|
+        Template.new(self, path.gsub(File.join(root), '')) unless File.directory?(path)
+      end.compact
+    end
+  end
+end
+module Evergreen
+  class Spec
+    def initialize(suite, name)
+      @suite = suite
+      @name = name
+      @name = "#{Evergreen.spec_dir}/#{name}" if !exist?
+    end
+    def name
+      @name.gsub("/#{Evergreen.spec_dir}/", '')
+    end
+  end
+end
+module Evergreen
+  class Template
+    def name
+      @name.gsub("/#{Evergreen.template_dir}/", '')
+    end
+    def full_path
+      File.join(root, @name)
+    end
+  end
+end

data/spec/dummy/config/initializers/additional_navigasmic.rb ADDED Viewed

@@ -0,0 +1,14 @@
+Navigasmic.setup do |config|
+  config.semantic_navigation :testing do |n|
+    n.item 'Home', proc{ root_path }
+    n.item 'Site Map', proc{ root_path(format: 'xml') }
+    n.item 'Blog', class: 'blog', highlights_on: [{controller: '/blog/posts'}, {controller: '/blog/links'}] do
+      n.item 'Articles', controller: '/blog/posts'
+      n.item 'Links', '/blog/links'
+      n.item 'Specific Article', link: {controller: '/blog/posts', action: 'show', id: '2'}
+      n.item 'Not Linked'
+    end
+  end
+end

data/spec/dummy/config/initializers/navigasmic.rb ADDED Viewed

@@ -0,0 +1,145 @@
+Navigasmic.setup do |config|
+  # Defining Navigation Structures:
+  #
+  # You can begin by defining your navigation structures here.  You can also define them directly in the view if you'd
+  # like, but it's recommended to eventually move them here to clean help up your views.  You can read about Navigasmic
+  # at https://github.com/jejacks0n/navigasmic
+  #
+  # When you're defining navigation here, it's basically the same as if you were doing it in the view but the scope is
+  # different.  It's important to understand that -- and use procs where you want things to execute in the view scope.
+  #
+  # Once you've defined some navigation structures and configured your builders you can render navigation in your views
+  # using the `semantic_navigation` view helper.  You can also use the same syntax to define your navigation structures
+  # in your views, and eventually move them here (it's handy to prototype navigation/css by putting them in the views
+  # first).
+  #
+  # <%= semantic_navigation :primary %>
+  #
+  # You can optionally provided a :builder and :config option to the semantic_navigation view helper.
+  #
+  # <%= semantic_navigation :primary, config: :blockquote %>
+  # <%= semantic_navigation :primary, builder: Navigasmic::Builder::MapBuilder %>
+  #
+  # When defining navigation in your views just pass it a block (the same as here basically).
+  #
+  # <%= semantic_navigation :primary do |n| %>
+  #   <% n.item 'About Me' %>
+  # <% end %>
+  #
+  # Here's a basic example:
+  config.semantic_navigation :primary do |n|
+    n.item 'Home', '/'
+    # Groups and Items:
+    #
+    # You can create a structure using `group`, and `item`.  You can nest items inside groups or items.  In the
+    # following example, the "Articles" item will always highlight on the blog/posts controller, and the nested article
+    # items will only highlight when on those specific pages.  The "Links" item will be disabled unless the user is
+    # logged in.
+    #
+    #n.group 'Blog' do
+    #  n.item 'Articles', controller: '/blog/posts' do
+    #    n.item 'First Article', '/blog/posts/1'
+    #    n.item 'Second Article', '/blog/posts/2', map: {changefreq: 'weekly'}
+    #  end
+    #  n.item 'Links', controller: '/blog/links', disabled_if: proc{ !logged_in? }
+    #end
+    #
+    # You can hide specific specific items or groups.  Here we specify that the "About" section of navigation should
+    # only be displayed if the user is logged in.
+    #
+    #n.group 'About', hidden_unless: proc{ logged_in? } do
+    #  n.item 'About Me', class: 'featured', link_html: {class: 'about-me'}
+    #end
+    #
+    # Scoping:
+    #
+    # Scoping is different than in the view here, so we've provided some nice things for you to get around that.  In
+    # the above example we just provide '/' as what the home page is, but that may not be correct.  You can also access
+    # the path helpers, using a proc, or by proxying them through the navigation object.  Any method called on the
+    # navigation scope will be called within the view scope.
+    #
+    #n.item 'Home', proc{ root_path }
+    #n.item 'Home', n.root_path
+    #
+    # This proxy behavior can be used for I18n as well.
+    #
+    #n.item n.t('hello'), '/'
+  end
+  # Setting the Default Builder:
+  #
+  # By default the Navigasmic::Builder::ListBuilder is used unless otherwise specified.
+  #
+  # You can change this here:
+  #config.default_builder = MyCustomBuilder
+  # Configuring Builders:
+  #
+  # You can change various builder options here by specifying the builder you want to configure and the options you
+  # want to change.
+  #
+  # Changing the default ListBuilder options:
+  config.builder Navigasmic::Builder::ListBuilder do |builder|
+    builder.wrapper_class = 'semantic-navigation'
+  end
+  # Naming Builder Configurations:
+  #
+  # If you want to define a named configuration for a builder, just provide a hash with the name, and the builder to
+  # configure.  The named configurations can then be used during rendering by specifying a `:config => :bootstrap`
+  # option to the `semantic_navigation` view helper.
+  #
+  # A Twitter Bootstrap configuration:
+  #
+  # Example usage:
+  #
+  # <%= semantic_navigation :primary, config: :bootstrap, class: 'nav-pills' %>
+  #
+  # Or to create a full navigation bar using twitter bootstrap you could use the following in your view:
+  # <div class="navbar">
+  #   <div class="navbar-inner">
+  #     <a class="brand" href="/">Title</a>
+  #     <%= semantic_navigation :primary, config: :bootstrap %>
+  #   </div>
+  # </div>
+  config.builder bootstrap: Navigasmic::Builder::ListBuilder do |builder|
+    # Set the nav and nav-pills css (you can also use 'nav nav-tabs') -- or remove them if you're using this inside a
+    # navbar.
+    builder.wrapper_class = 'nav nav-pills'
+    # Set the classed for items that have nested items, and that are nested items.
+    builder.has_nested_class = 'dropdown'
+    builder.is_nested_class = 'dropdown-menu'
+    # For dropdowns to work you'll need to include the bootstrap dropdown js
+    # For groups, we adjust the markup so they'll be clickable and be picked up by the javascript.
+    builder.label_generator = proc do |label, has_link, has_nested|
+      if !has_nested || has_link
+        "<span>#{label}</span>"
+      else
+        link_to("#{label}<b class='caret'></b>".html_safe, '#', class: 'dropdown-toggle', data: {toggle: 'dropdown'})
+      end
+    end
+    # For items, we adjust the links so they're '#', and do the same as for groups.  This allows us to use more complex
+    # highlighting rules for dropdowns.
+    builder.link_generator = proc do |label, link, options, has_nested|
+      if has_nested
+        link = '#'
+        label << "<b class='caret'></b>"
+        options.merge!(class: 'dropdown-toggle', data: {toggle: 'dropdown'})
+      end
+      link_to(label, link, options)
+    end
+  end
+end

data/spec/dummy/config/initializers/secret_token.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '990bac5b6d4f068883259503539cad4e9ec00f137986fcbc718a1e0b645af7a3eb0340468f8fae09958a6281190396d65789b6316af61e47a8cbda3c8c071a0e'

data/spec/dummy/config/initializers/session_store.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/locales/en.yml ADDED Viewed

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+en:
+  hello: "Localized label"

data/spec/dummy/config/routes.rb ADDED Viewed

@@ -0,0 +1,68 @@
+Dummy::Application.routes.draw do
+  root to: 'application#welcome'
+  match '/my_awesome_blog' => 'blog/posts#index', as: :my_awesome_blog
+  namespace :blog do
+    resources :posts
+    resources :links
+  end
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => 'welcome#index'
+  # See how all your routes lay out with "rake routes"
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id))(.:format)'
+end