actionnav 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3139471d9e398daa9e8e509f374be2077ec99ee8
+  data.tar.gz: da0f5b8f07d8e02e2214261dfa6aafca1f870207
+SHA512:
+  metadata.gz: a5f0b4e891687847b56360cf59f2d4300f42016336680d534061547fff5c85b4dafbeccdf207e671ad7892549da71d9d0b43c3b49a248cb6548feacff782dd10
+  data.tar.gz: e9bf9423862d3465a095485480742fffb6d394cfb1fe77ac53f496fe6fb1aabb5d378cccda5a9e2811ea74666e4e4c0e421719d75ab802cce871d36686f60bf0

data/lib/action_nav.rb

@@ -0,0 +1,5 @@
+require 'action_nav/base'
+
+if defined?(Rails)
+  require 'action_nav/railtie'
+end

data/lib/action_nav/base.rb

@@ -0,0 +1,71 @@
+require 'action_nav/item'
+require 'action_nav/item_instance'
+require 'action_nav/item_dsl'
+
+module ActionNav
+  class Base
+
+    # Initialize a new navigation
+    #
+    # @param controller [ActionController::Base]
+    # @return [ActionNav::Base]
+    def initialize(controller)
+      @controller = controller
+      @active_paths = []
+    end
+
+    # The controller that initialized this navigation.
+    #
+    # @return [ActionController::Base]
+    attr_reader :controller
+    attr_reader :active_paths
+
+    # Return a full list of items for this instance as
+    # instances.
+    #
+    # @return [Array<ActionNav::ItemInstance>]
+    def items
+      @items ||= self.class.items.each_with_object([]) do |(key, item), array|
+        instance = ItemInstance.new(self, item)
+        unless instance.hidden?
+          array << instance
+        end
+      end
+    end
+
+    # Add an active navigation by passing the full path to
+    # active item.
+    def activate(*parts)
+      @active_paths.push(parts)
+    end
+    alias_method :active, :activate
+
+    # Is the given active path?
+    #
+    # @return [Boolean]
+    def active_path?(*parts)
+      @active_paths.any? do |path|
+        a = path.size.times.map { |i| path[0, path.size - i] }
+        a.include?(parts)
+      end
+    end
+
+    # Add a new item to this navigation
+    #
+    # @param id [Symbol]
+    # @return [ActionNav::Item]
+    def self.item(id, &block)
+      item = Item.new(nil, id)
+      item.dsl(&block) if block_given?
+      items[id] = item
+    end
+
+    # Return all items for this navigation
+    #
+    # @return [Hash]
+    def self.items
+      @items ||= {}
+    end
+
+  end
+end

data/lib/action_nav/controller_extension.rb

@@ -0,0 +1,17 @@
+require 'action_nav/set'
+
+module ActionNav
+  module ControllerExtension
+
+    def self.included(base)
+      base.class_eval do
+        helper_method :navigation
+      end
+    end
+
+    def navigation
+      @navigation ||= Set.new(self)
+    end
+
+  end
+end

data/lib/action_nav/item.rb

@@ -0,0 +1,45 @@
+require 'action_nav/item_dsl'
+
+module ActionNav
+  class Item
+
+    def initialize(parent, id)
+      @id = id
+      @parent = parent
+      @children = {}
+    end
+
+    attr_reader :id
+    attr_reader :children
+    attr_accessor :title
+    attr_accessor :url
+    attr_accessor :description
+    attr_accessor :icon
+    attr_accessor :hide_unless
+
+    def path
+      @parent ? [@parent.path, id].flatten : [id]
+    end
+
+    def add_child(id, &block)
+      child_item = Item.new(self, id)
+      block.call(child_item) if block_given?
+      @children[id] = child_item
+    end
+
+    def child(*ids)
+      previous = self
+      ids.each do |id|
+        previous = previous.children[id]
+        return nil if previous.nil?
+      end
+      previous
+    end
+
+    def dsl(&block)
+      ItemDSL.new(self).instance_eval(&block)
+      self
+    end
+
+  end
+end

data/lib/action_nav/item_dsl.rb

@@ -0,0 +1,35 @@
+module ActionNav
+  class ItemDSL
+
+    def initialize(item)
+      @item = item
+    end
+
+    def title(title = nil, &block)
+      @item.title = block_given? ? block : title
+    end
+
+    def url(url = nil, &block)
+      @item.url = block_given? ? block : url
+    end
+
+    def description(description = nil, &block)
+      @item.description = block_given? ? block : description
+    end
+
+    def icon(icon = nil, &block)
+      @item.icon = block_given? ? block : icon
+    end
+
+    def hide_unless(&block)
+      @item.hide_unless = block
+    end
+
+    def item(id, &block)
+      child = @item.add_child(id)
+      child.dsl(&block)
+      child
+    end
+
+  end
+end

data/lib/action_nav/item_instance.rb

@@ -0,0 +1,90 @@
+require 'active_support/inflector/methods'
+
+module ActionNav
+  class ItemInstance
+
+    attr_reader :item
+
+    def initialize(base, item)
+      @base = base
+      @item = item
+    end
+
+    def id
+      @item.id
+    end
+
+    def path
+      @item.path
+    end
+
+    def items
+      @item.children.each_with_object([]) do |(_, item), array|
+        instance = ItemInstance.new(@base, item)
+        unless instance.hidden?
+          array << instance
+        end
+      end
+    end
+
+    def active?
+      @base.active_path?(*self.path)
+    end
+
+    def title
+      cache(:title) { parse(@item.title, ActiveSupport::Inflector.humanize(@item.id.to_s)) }
+    end
+
+    def description
+      cache(:description) { parse(@item.description) }
+    end
+
+    def description?
+      !!description
+    end
+
+    def url
+      cache(:url) { parse(@item.url, "/")}
+    end
+
+    def icon
+      cache(:icon) { parse(@item.icon) }
+    end
+
+    def icon?
+      !!icon
+    end
+
+    def hidden?
+      cache(:hidden?) do
+        if @item.hide_unless
+          parse(@item.hide_unless, false) == false
+        else
+          false
+        end
+      end
+    end
+
+    private
+
+    def parse(item, default = nil)
+      if item.is_a?(Proc)
+        @base.controller.instance_eval(&item)
+      elsif item
+        item.to_s
+      else
+        default
+      end
+    end
+
+    def cache(name, &block)
+      @cache ||= {}
+      if @cache.keys.include?(name)
+        @cache[name]
+      else
+        @cache[name] = block.call
+      end
+    end
+
+  end
+end

data/lib/action_nav/railtie.rb

@@ -0,0 +1,12 @@
+module ActionNav
+  class Railtie < Rails::Railtie
+
+    initializer 'actionnav.initialize' do |app|
+      ActiveSupport.on_load :action_controller do
+        require 'action_nav/controller_extension'
+        include ActionNav::ControllerExtension
+      end
+    end
+
+  end
+end

data/lib/action_nav/set.rb

@@ -0,0 +1,18 @@
+require 'active_support/inflector/inflections'
+
+module ActionNav
+  class Set
+
+    def initialize(controller)
+      @controller = controller
+      @navigations = {}
+    end
+
+    def [](name)
+      @navigations[name] ||= begin
+        "#{name.to_s}_navigation".classify.constantize.new(@controller)
+      end
+    end
+
+  end
+end

data/lib/action_nav/version.rb

@@ -0,0 +1,3 @@
+module ActionNav
+  VERSION = "1.0.0"
+end

data/lib/actionnav.rb

@@ -0,0 +1 @@
+require 'action_nav'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: actionnav
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEZDCCAsygAwIBAgIBATANBgkqhkiG9w0BAQsFADA8MQswCQYDVQQDDAJtZTEZ
+  MBcGCgmSJomT8ixkARkWCWFkYW1jb29rZTESMBAGCgmSJomT8ixkARkWAmlvMB4X
+  DTE4MDMwNTE3MzAwNVoXDTE5MDMwNTE3MzAwNVowPDELMAkGA1UEAwwCbWUxGTAX
+  BgoJkiaJk/IsZAEZFglhZGFtY29va2UxEjAQBgoJkiaJk/IsZAEZFgJpbzCCAaIw
+  DQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAOH6HpXwjmVYrUQxUHm25mLm9qYK
+  WS66Me1IfMUX3ZREZ/GzqiJZdV6itPuaaaKpbcm2A/KjgGSPOi9FZBneZ5KvbIeK
+  /GsixL98kxB06q9DZwJbFz7Inklxkd/S0anm+PxtWkQP1TLkMsviRcBPEAqSLON9
+  dCKC7+3kibhatdlsbqIQaeEhSoCUipYMi7ZyFHu5Qz+zMwc8JwHvQ4yi8cMa/QZ+
+  s1tN4mkp/6vWWj4G4lF3YjFYyt2txJcK5ELDtyBy7a3vbMImPy9pplFx1/M6SNpn
+  7Pck0LqDprRzJXsGjq3CbC0nUaudFjUPr31KwxMYq1u13aQL9YuO3GeQCQ3gvdlJ
+  TSd7zoGgLwrMGmXqgd392Psr29yp+WBLcvhFUJnNPDV8nlph/cqmRzoIewP1kdPq
+  pEIUIJQdyKJU7gmFlJ1FurarkuT0a2Rgs99WokCoXLxuPmRWQRN1sH2nHL70jgAR
+  UuvyXEtyALHoCn3VqBR7ZvpfDblUzfANQDhBgwIDAQABo3EwbzAJBgNVHRMEAjAA
+  MAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUa7gxxSE4SO2Ors4B+y3qANdMpo4wGgYD
+  VR0RBBMwEYEPbWVAYWRhbWNvb2tlLmlvMBoGA1UdEgQTMBGBD21lQGFkYW1jb29r
+  ZS5pbzANBgkqhkiG9w0BAQsFAAOCAYEAkbz/AJwBsRKwgt2BhWqgr/egf/37IS3s
+  utVox7feYutKyFDHXYvCjm64XUJNioG7ipbRwOOGs5bEYfwgkabcAQnxSlkdNjc4
+  JIgL/cF4YRg8uJG7DH+LwpydXHqr7RneDiONuiHlEN/1EZZ8tjwXypdwzhQ2/6ot
+  YOxdSi/mXdoDoFlIebsLyInUZjqnm7dQ9nTTUNSB+1LoOD8ARNhTIPnKCnxwZd56
+  giOxoHuJIOhgi6U2zicZJHv8lUj2Lc3bcirQk5eeOFRPVGQSpLLoqA7dtS7Jy4cv
+  3c5m+HyxSxzlrcVHMAgJYemK0uhVQD9Y6JwHKDroWDH+MPALjlScw8ui1jmNuH31
+  n5JOH/07C4gYcwTjJmtoRSov46Z6Gn5cc6NFkQpA185pbRLqEDKzusXvBOQlAOLh
+  iyQrH6PJ0xgVJNYx+DLq3eFmo2hYJkw/lVhYAK+MdajtYJbD5VvCIEHO0d5RRgV+
+  qnCNZoPPy0UtRmGKZTMZvVJEZiw4g0fY
+  -----END CERTIFICATE-----
+date: 2018-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A navigation manager for Rails applications.
+email:
+- me@adamcooke.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/action_nav.rb
+- lib/action_nav/base.rb
+- lib/action_nav/controller_extension.rb
+- lib/action_nav/item.rb
+- lib/action_nav/item_dsl.rb
+- lib/action_nav/item_instance.rb
+- lib/action_nav/railtie.rb
+- lib/action_nav/set.rb
+- lib/action_nav/version.rb
+- lib/actionnav.rb
+homepage: https://github.com/adamcooke/actionnav
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: This gem provides a friendly way to manage application navigation.
+test_files: []