navigator_rails 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f67ddd75cd352cf56cf93de0790997a2b517b18c
+  data.tar.gz: eb67d1513a5f388eda9bd57e7fb9967b7218e785
+SHA512:
+  metadata.gz: 357bfea36b1aa0c632f68ca91bb4b5d847948f9b6b4ccd2378687e70bc578fc504bca3df358bc83fde773e7ab023eb88dec8203669afb15efbd031811eb18718
+  data.tar.gz: b257b240bbcab1adad13b1a5a5fe3a2be6f65e8e10e9d3d2564f7f976b22ed24b8ba74a7c3838a5909e8fa15e17e9c72011ba4b9ca5707503add1d05d2665ff1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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.rdoc

@@ -0,0 +1,3 @@
+= NavigatorRails
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NavigatorRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/navigator_rails/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate navigator_rails Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/navigator_rails/install_generator.rb

@@ -0,0 +1,8 @@
+module NavigatorRails
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    def copy_initializer_file
+      copy_file 'initializer.rb', 'config/initializers/navigator.rb'
+    end
+  end
+end

data/lib/generators/navigator_rails/templates/initializer.rb

@@ -0,0 +1,6 @@
+NavigatorRails.config do
+  use    devise: '/head/right'
+  use    :cancan
+  use    :rolify
+  brand  path: :head, content: '<span class="ion-cube"></span>Project Name'
+end

data/lib/navigator_rails/builder.rb

@@ -0,0 +1,16 @@
+module NavigatorRails
+  module Builder
+    def navigator_builder
+      def path       param; @i.send("#{__method__}=",param);      end
+      def order      param; @i.send("#{__method__}=",param);      end
+      def content    param; @i.send("#{__method__}=",param.call); end
+      def constraint param; @i.send("#{__method__}=",param);      end
+      def decorator  param; @i.send("#{__method__}=",param);      end
+      def type       param; @i.send("#{__method__}=",param);      end
+      @i = Item.new
+      yield
+      @i.save
+    end
+  end
+end
+

data/lib/navigator_rails/config.rb

@@ -0,0 +1,60 @@
+module NavigatorRails
+  module Config
+    def config &block
+      if block_given?
+        @config ||= {
+          default_constraint: true,
+          use_cancan: false,
+          use_devise: false,
+          use_rolify: false,
+           search_at: %w{ app/controllers },
+         controllers: [],
+          decorators: [ :navigator, :navbar, :submenu, :link ],
+        }
+        class_eval(&block)
+        Decorator.instance
+        Store.instance
+        Store.collect
+        Store.process_config_builders
+      else
+        @config
+      end
+    end
+    def brand params={}
+      params[:path]    and path    = "/#{params[:path].to_s}/brand"
+      params[:content] and content = params[:content]
+      path    ||= '/head'
+      content ||= '<span class="ion-cube">Project Name</span>'
+
+      @config[:build_brand] = {path: path, content: content}
+    end
+    def use *params
+      if params.count == 1 and params.first.class == Hash
+        features = params.first.keys
+        params.first.each do |builder,path|
+          @config["build_#{builder}_at".to_sym] = path
+        end
+      else
+        features = params
+      end
+      features.each do |feature|
+        @config["use_#{feature}".to_sym] = true
+      end
+    end
+    def constraint constraint
+      @config[:default_constraint] = constraint
+    end
+    def cancan?
+      defined?(CanCan) and true
+    end
+    def devise?
+      defined?(Devise) and true
+    end
+    def rolify?
+      defined?(Rolify) and true
+    end
+    def rails?
+      defined?(Rails) and true
+    end
+  end
+end

data/lib/navigator_rails/constraint.rb

@@ -0,0 +1,12 @@
+module NavigatorRails
+  class Constraint
+    include Singleton
+    extend NavigatorRails::Contextable
+    class << self
+      def default; NavigatorRails::Constraint.instance.default; end
+    end
+    def default
+      NavigatorRails.config[:default_constraint]
+    end
+  end
+end

data/lib/navigator_rails/contextable.rb

@@ -0,0 +1,13 @@
+module NavigatorRails
+  module Contextable
+    attr_accessor :context      
+    def patch_context
+      return if @context.eval('self.methods.include? :navigator_builder')
+      @context.eval('extend NavigatorRails::Builder')
+    end
+    def process code
+      patch_context
+      @context.eval(code)
+    end
+  end
+end

data/lib/navigator_rails/decorator.rb

@@ -0,0 +1,23 @@
+module NavigatorRails
+  class Decorator
+    include Singleton
+    extend NavigatorRails::Contextable
+    class << self
+      def at params; Decorator.instance.at params; end
+      def for decorator; Decorator.instance.for decorator; end
+      def register type, decorator; Decorator.instance.register type, decorator; end
+    end
+    def initialize
+      @decorators = {}
+    end
+    def at params={}
+      return NavigatorRails.config[:decorators][params[:level]-1] if params[:level]
+    end
+    def for type
+      @decorators[type] if @decorators[type]
+    end
+    def register type, decorator
+      @decorators[type] = decorator
+    end
+  end
+end

data/lib/navigator_rails/decorators/brand.rb

@@ -0,0 +1,12 @@
+module NavigatorRails
+  module Decorators
+    class Brand
+      include NavigatorRails::Decorators::Generic
+      def template
+        <<-LINK_DECORATION.strip_heredoc
+          <%= resource.content %>
+        LINK_DECORATION
+      end
+    end
+  end
+end

data/lib/navigator_rails/decorators/generic.rb

@@ -0,0 +1,63 @@
+module NavigatorRails
+  module Decorators
+    module Generic
+      class << self
+        def included base
+          type      = base.to_s.demodulize.downcase.to_sym
+          decorator = base
+          base.send(:extend,NavigatorRails::Decorators::Generic)
+          decorator.type = type
+          base.send(:include,Singleton)
+          NavigatorRails::Decorator.register type, decorator.instance
+        end
+      end
+      attr_accessor :type
+      def resource
+        @resource
+      end
+      def children_with params={}
+        children = Store.children_of resource
+        if params[:except]
+          children = children.collect do |child|
+            unless child.type
+              child
+            else
+              child unless child.type.to_sym == params[:except].to_sym
+            end
+          end.compact
+        end
+        if params[:only]
+          children = children.collect do |child|
+            next unless child.type
+            child if child.type.to_sym == params[:except].to_sym
+          end.compact
+        end
+        children
+      end
+      def child_count
+        children_with.count
+      end
+      def has_visible_children
+        children_with.collect do |child|
+          child.constraint
+        end.reduce(:|)
+      end
+      def children params={}
+        children = children_with params
+        children.collect do |child|
+          next unless child.constraint
+          child.decorator.draw(child).html_safe
+        end.join
+      end
+      def children_of resource
+      end
+      def draw resource
+        old_resource = @resource
+        @resource = resource
+        output = ERB.new(template).result(binding).html_safe
+        @resource = old_resource
+        output
+      end
+    end
+  end
+end

data/lib/navigator_rails/decorators/link.rb

@@ -0,0 +1,12 @@
+module NavigatorRails
+  module Decorators
+    class Link
+      include NavigatorRails::Decorators::Generic
+      def template
+        <<-LINK_DECORATION.strip_heredoc
+          <li><%= resource.content %></li>
+        LINK_DECORATION
+      end
+    end
+  end
+end

data/lib/navigator_rails/decorators/navbar.rb

@@ -0,0 +1,15 @@
+module NavigatorRails
+  module Decorators
+    class Navbar
+      include NavigatorRails::Decorators::Generic
+      def template
+        return '' unless has_visible_children
+        <<-LINK_DECORATION.strip_heredoc
+          <ul class="nav navbar-nav navbar-<%= resource.relative_path %>">
+            <%= children %>
+          </ul>
+        LINK_DECORATION
+      end
+    end
+  end
+end

data/lib/navigator_rails/decorators/navigator.rb

@@ -0,0 +1,31 @@
+module NavigatorRails
+  module Decorators
+    class Navigator
+      include NavigatorRails::Decorators::Generic
+      def brand
+        brand = Store.children_of(resource).select{|x|x.type==:brand}.first
+        brand.decorator.draw(brand).html_safe
+      end
+      def template
+        <<-LINK_DECORATION.strip_heredoc
+          <div class="navbar navbar-default navbar-fixed-top">
+            <div class="container">
+              <div class="navbar-header">
+                <button type="button" data-toggle="collapse" data-target=".navbar-collapse" class="navbar-toggle">
+                  <span class="sr-only">Toggle navigation</span>
+                  <span class="icon-bar"></span>
+                  <span class="icon-bar"></span>
+                  <span class="icon-bar"></span>
+                </button>
+                <%= brand %>
+              </div>
+            <div class="collapse navbar-collapse">
+              <%= children except: :brand %>
+            </div>
+          </div>
+        </div>
+        LINK_DECORATION
+      end
+    end
+  end
+end

data/lib/navigator_rails/decorators/submenu.rb

@@ -0,0 +1,18 @@
+module NavigatorRails
+  module Decorators
+    class Submenu
+      include NavigatorRails::Decorators::Generic
+      def template
+        return '' unless has_visible_children
+        <<-LINK_DECORATION.strip_heredoc
+          <li class="dropdown">
+            <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"><%= resource.content %> <span class="caret"></span></a>
+            <ul class="dropdown-menu" role="menu">
+              <%= children %>
+            </ul>
+          </li>
+        LINK_DECORATION
+      end
+    end
+  end
+end

data/lib/navigator_rails/decorators.rb

@@ -0,0 +1,6 @@
+require 'navigator_rails/decorators/generic'
+require 'navigator_rails/decorators/navigator'
+require 'navigator_rails/decorators/navbar'
+require 'navigator_rails/decorators/submenu'
+require 'navigator_rails/decorators/link'
+require 'navigator_rails/decorators/brand'

data/lib/navigator_rails/engine.rb

@@ -0,0 +1,24 @@
+require 'navigator_rails/config'
+require 'navigator_rails/navigatable'
+require 'navigator_rails/contextable'
+require 'navigator_rails/store'
+require 'navigator_rails/helpers'
+require 'navigator_rails/builder'
+require 'navigator_rails/constraint'
+require 'navigator_rails/item'
+require 'navigator_rails/decorator'
+require 'navigator_rails/decorators'
+
+module NavigatorRails
+  class Engine < ::Rails::Engine
+    initializer 'navigator_rails.add_navigator' do
+      config.to_prepare do
+        ApplicationController.send(:include,Helpers::ApplicationHelper)
+        Store.collect
+      end
+    end
+  end
+  class << self
+    include Config
+  end
+end

data/lib/navigator_rails/helpers/application_helper.rb

@@ -0,0 +1,15 @@
+module NavigatorRails
+  module Helpers
+    module ApplicationHelper
+      def self.included(base)
+        base.class_eval do
+          require 'navigator_rails/navigator'
+          helper_method :navigator
+          def navigator
+            @navigator = NavigatorRails::Navigator
+          end
+        end
+      end
+    end
+  end
+end

data/lib/navigator_rails/helpers.rb

@@ -0,0 +1 @@
+require 'navigator_rails/helpers/application_helper.rb'

data/lib/navigator_rails/item.rb

@@ -0,0 +1,36 @@
+module NavigatorRails
+  class Item
+    include ActiveModel::Model
+    class << self
+      def level_of path
+        path.count('/')
+      end
+      def normalize_path path
+        path = path.to_s
+        path = "/#{path}" unless path =~ /^\//
+        path
+      end
+    end
+    attr_accessor :path, :order, :type
+    attr_writer :content, :constraint
+    def save
+      self.type ||= Decorator.at level: self.level
+      Store.add self
+    end
+    def level
+      Item.level_of self.path 
+    end
+    def relative_path
+      File.basename path
+    end
+    def decorator
+      Decorator.for self.type
+    end
+    def content
+      Decorator.process(@content.to_s) rescue Store.delete self
+    end
+    def constraint
+      Constraint.process(@constraint.to_s) rescue Store.delete self
+    end
+  end
+end

data/lib/navigator_rails/navigatable.rb

@@ -0,0 +1,14 @@
+module NavigatorRails
+  module Navigatable
+    extend ActiveSupport::Concern
+    included do
+      class_attribute :navigator_rails_items
+    end
+    module ClassMethods
+      def menu_item params={}
+        self.navigator_rails_items ||= []
+        self.navigator_rails_items  << Item.new(params)
+      end
+    end
+  end
+end

data/lib/navigator_rails/navigator.rb

@@ -0,0 +1,18 @@
+module NavigatorRails
+  class Navigator
+    class << self
+      def render path
+        context   = binding.of_caller(1)
+
+        Constraint.context=context
+        Decorator.context=context
+
+        path      = Item.normalize_path(path)
+        resource  = Store.get(path)
+        decorator = Decorator.for(:navigator)
+        
+        decorator.draw(resource).html_safe
+      end
+    end
+  end
+end

data/lib/navigator_rails/store.rb

@@ -0,0 +1,117 @@
+require 'sourcify'
+
+module NavigatorRails
+  class Store
+    include Singleton
+    class << self
+      def add item; Store.instance.add item; end
+      def get path; Store.instance.get path; end
+      def delete item; Store.instance.delete item; end
+      def collect;  Store.instance.collect; end
+      def children_of resource; Store.instance.children_of resource; end
+      def process_items; Store.instance.process_items; end
+      def process_config_builders; Store.instance.process_config_builders; end
+    end
+    def initialize
+      puts "Initializing store"
+      @items     ||= []
+    end
+    def items
+      @items
+    end
+    def add item
+      @items.each do |dbitem|
+        return if dbitem.path == item.path
+      end
+      @items << item
+      fill_gaps
+    end
+    def get path
+      @items.collect do |item|
+        item if item.path == path
+      end.compact.first
+    end
+    def delete item
+      @items.delete(item)
+    end
+    def children_of resource
+      @items.collect do |item|
+        next unless item.path  =~ /^#{resource.path}\//
+        next unless item.level == resource.level+1
+        item
+      end.compact
+    end
+    def process_config_builders
+      NavigatorRails.config.each do |param,value|
+        next unless param =~ /^build_/
+        case param
+        when :build_devise_at
+          parent_path = Item.normalize_path value
+          Item.new(path: "#{parent_path}/Profile", type: :link, constraint: 'user_signed_in?', content: "link_to('Profile', edit_user_registration_url)").save
+          Item.new(path: "#{parent_path}/SignOut", type: :link, constraint: 'user_signed_in?', content: "link_to('Sign Out', destroy_user_session_url, method: :delete)").save
+          Item.new(path: "#{parent_path}/SignIn", type: :link, constraint: 'not user_signed_in?', content: "link_to('Sign In', new_user_session_url)").save
+          Item.new(path: "#{parent_path}/SignUp", type: :link, constraint: 'not user_signed_in?', content: "link_to('Sign Up', new_user_registration_url)").save
+        when :build_brand
+          Item.new(type: :brand, type: :brand, path: value[:path], content: "link_to(raw('#{value[:content]}'),root_url, class: 'navbar-brand')").save
+        end
+      end
+    end
+    def get_controller dir, file
+      begin 
+        return file.sub(/^#{dir}\//, '').sub(/\.rb$/,'').classify.constantize
+      rescue NameError
+        return
+      end
+    end
+    def register_controller controller
+      NavigatorRails.config[:controllers] << controller
+    end
+    def get_items_of controller
+      if defined?(controller.navigator_rails_items)
+        register_controller controller
+        return unless controller.navigator_rails_items
+        controller.navigator_rails_items.collect do |item|
+          item.save
+        end
+      end
+    end
+    def collect
+      NavigatorRails.config[:search_at].each do |dir|
+        Dir["#{dir}/**/*.rb"].each do |file|
+          get_items_of get_controller(dir, file)
+        end
+      end
+    end
+    private
+    def fill_gaps
+      paths = []
+      @items.each do |item|
+        path = item.path
+        loop do
+          break if path.empty?
+          break if paths.include? path
+          paths << path
+          path = path.split('/')[0..-2].join('/')
+        end
+      end
+      paths.each do |path|
+        next unless get(path).nil?
+        level      = Item.level_of path
+        type       = Decorator.at level: level
+        constraint = Constraint.default
+        content    = "#{File.basename(path)}"
+        begin
+          content.singularize.constantize.model_name.human(count: 2)
+          i18n_content = "'#{content}'.singularize.constantize.model_name.human(count: 2)"
+        rescue I18n::InvalidPluralizationData
+          content.singularize.constantize.model_name.human(count: 1)
+          i18n_content = "'#{content}'.singularize.constantize.model_name.human(count: 1)"
+        rescue NameError
+          nil
+        end
+        content  =i18n_content ? i18n_content : "'#{content}'"
+        Item.new(path:path, type: type, content: content, constraint: constraint).save
+      end
+    end
+  end
+end

data/lib/navigator_rails/version.rb

@@ -0,0 +1,3 @@
+module NavigatorRails
+  VERSION = "0.0.4"
+end

data/lib/navigator_rails.rb

@@ -0,0 +1,4 @@
+require "navigator_rails/engine"
+
+module NavigatorRails
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks