active_admin-subnav 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c48d9e15942740b72a37b67dc9aa59a20687ad0f
+  data.tar.gz: 6df97455b50cc0015bde079189cc15e9b26095a4
+SHA512:
+  metadata.gz: 14c65d77a8a5ee8af8a2a22b00d5d6f73a07448ace0abd68625ef907a5cee75e9cc7346e66edf3b70e1246a04667864edcd68525c4696d3bac39c88c0576b237
+  data.tar.gz: ce9920299f5832201c07aa03edf7788801a7d1a9f7b26f4338783333454f0603eb18b66fcc31bb1a68ee190bfc360f2f79f44a1528ab8b49edcfe0488738fc4e

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activeadmin-subnav.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Charles Maresh
+
+MIT License
+
+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,37 @@
+# Activeadmin::Subnav
+
+Provide sub-navigation menu for resources belonging to a parent resource.
+
+Currently, ActiveAdmin 1.0pre resets the top navigation menu to display the sub
+navigation menu for all resources related to that parent resource. This gem
+provides a sub navigation menu for those resources.
+
+NOTE: Optional belongs_to configurations are not supported!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activeadmin-subnav'
+
+And then execute:
+
+    $ bundle
+
+Add the subnav's styles to your `active_admin.css.scss` stylesheet:
+
+    //= require active_admin/subnav
+
+    // Align subnav with main navigation by padding the width of the site's
+    // titie.
+    #header div.subnav {
+      padding-left: 8.333em;
+    }
+
+## Contributing
+
+1. Fork it ( https://github.com/zorab47/activeadmin-subnav/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/active_admin-subnav.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_admin/subnav/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_admin-subnav"
+  spec.version       = Activeadmin::Subnav::VERSION
+  spec.authors       = ["Charles Maresh"]
+  spec.email         = ["charles.maresh@orm-tech.com"]
+  spec.summary       = %q{Provide sub-navigation menu for resources belonging to a parent resource.}
+  spec.description   = <<DESC
+Currently, ActiveAdmin 1.0pre resets the top navigation menu to display the sub
+navigation menu for all resources related to that parent resource. This gem
+provides a sub navigation menu for those resources.
+DESC
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activeadmin"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-spec-expect"
+  spec.add_development_dependency "sass-rails"
+end

data/app/assets/stylesheets/active_admin/subnav.css.scss

@@ -0,0 +1,21 @@
+div.navigation.has_subnav {
+  margin-bottom: 5px;
+}
+
+div.subnav {
+  background-color: lighten(#53595D, 20%);
+  padding: 5px 20px 2px;
+  margin-bottom: -6px;
+
+  ul.tabs {
+    & > li {
+      &.has_nested > a {
+        z-index: 1009;
+      }
+      ul {
+        z-index: 1008;
+      }
+    }
+  }
+}
+

data/lib/active_admin/subnav.rb

@@ -0,0 +1,30 @@
+require "active_admin"
+
+require "active_admin/subnav/version"
+
+require "active_admin/subnav/views/header_with_subnav"
+
+require "active_admin/subnav/extensions/base_controller"
+require "active_admin/subnav/extensions/namespace"
+require "active_admin/subnav/extensions/page"
+require "active_admin/subnav/extensions/resource"
+require "active_admin/subnav/extensions/resource_menu"
+require "active_admin/subnav/extensions/tabbed_navigation"
+
+module ActiveAdmin
+  module Subnav
+    class Engine < ::Rails::Engine
+    end
+  end
+end
+
+
+# Register a TabbedNavigation view for the sub navigation.
+ActiveAdmin::ViewFactory.register sub_navigation: ActiveAdmin::Views::TabbedNavigation,
+                                  header:         ActiveAdmin::Views::HeaderWithSubnav
+
+ActiveAdmin::Page.send :include, ActiveAdmin::Subnav::Page
+
+ActiveAdmin.after_load do
+  ActiveAdmin::BaseController.send :include, ActiveAdmin::Subnav::MenuExtensions
+end

data/lib/active_admin/subnav/extensions/base_controller.rb

@@ -0,0 +1,34 @@
+module ActiveAdmin
+  module Subnav
+    module MenuExtensions
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :sub_menu
+
+        # Facilitate AA submenus by providing the resource class's ID to
+        # sub-resources to generate URLs.
+        before_action do
+          if params[:id] && defined?(resource_class) && params[:"#{resource_class.name.underscore}_id"].nil?
+            params[:"#{resource_class.name.underscore}_id"] = params[:id]
+          end
+        end
+      end
+
+      def sub_menu
+        active_admin_config.sub_navigation_menu
+      end
+
+      # Delegates to super to set @current_tab. Also sets @current_sub_tab to
+      # be name of the sub menu tab to mark as current.
+      def set_current_tab
+        super
+
+        @current_sub_tab =
+          if active_admin_config.show_sub_menu?(params[:action])
+            active_admin_config.menu_item
+          end
+      end
+    end
+  end
+end

data/lib/active_admin/subnav/extensions/namespace.rb

@@ -0,0 +1,40 @@
+module ActiveAdmin
+  class Namespace
+
+    attr_reader :sub_menus
+
+    # Override reset_menu!
+    def reset_menu!
+      @menus.clear!
+      @sub_menus.clear!
+    end
+
+    # Override build_menu_collection
+    def build_menu_collection
+      @menus     = MenuCollection.new
+      @sub_menus = MenuCollection.new
+
+      @menus.on_build do |menus|
+        build_default_utility_nav
+
+        resources.each do |resource|
+          resource.add_to_menu(@menus)
+        end
+
+        @sub_menus.send :build_menus!
+      end
+
+      @sub_menus.on_build do |menus|
+        resources.each do |resource|
+          if resource.belongs_to?
+            resource.belongs_to_config.target.nested_resources = true
+          end
+
+          resource.add_to_sub_menu(@sub_menus)
+        end
+      end
+    end
+
+  end
+end
+

data/lib/active_admin/subnav/extensions/page.rb

@@ -0,0 +1,11 @@
+module ActiveAdmin
+  module Subnav
+    module Page
+      extend ActiveSupport::Concern
+
+      def show_sub_menu?(*)
+        false
+      end
+    end
+  end
+end

data/lib/active_admin/subnav/extensions/resource.rb

@@ -0,0 +1,23 @@
+module ActiveAdmin
+  class Resource
+
+    # TODO: Support for optional belongs_to
+    def belongs_to(target, options = {})
+      @belongs_to = Resource::BelongsTo.new(self, target, options)
+      self.sub_navigation_menu_name = target
+      controller.send :belongs_to, target, options.dup
+    end
+
+    def nested_resources=(value)
+      @nested_resources = value
+    end
+
+    def has_nested_resources?
+      @nested_resources
+    end
+
+    def show_sub_menu?(action)
+      sub_menu_item? || (has_nested_resources? && ["show", "edit"].include?(action))
+    end
+  end
+end

data/lib/active_admin/subnav/extensions/resource_menu.rb

@@ -0,0 +1,33 @@
+module ActiveAdmin
+  class Resource
+    module Menu
+      attr_accessor :sub_navigation_menu_name
+
+      # Override add_to_menu
+      def add_to_menu(menu_collection)
+        if include_in_menu? && !sub_menu_item?
+          @menu_item = menu_collection.add navigation_menu_name, menu_item_options
+        end
+      end
+
+      def sub_navigation_menu
+        if has_nested_resources? && !sub_menu_item?
+          menu = resource_name.to_s.underscore.to_sym
+          namespace.sub_menus.fetch(menu)
+        else
+          namespace.sub_menus.fetch(sub_navigation_menu_name)
+        end
+      end
+
+      def add_to_sub_menu(menu_collection)
+        if include_in_menu? && sub_menu_item?
+          @menu_item = menu_collection.add sub_navigation_menu_name, menu_item_options
+        end
+      end
+
+      def sub_menu_item?
+        !sub_navigation_menu_name.nil?
+      end
+    end
+  end
+end

data/lib/active_admin/subnav/extensions/tabbed_navigation.rb

@@ -0,0 +1,23 @@
+
+module ActiveAdmin
+  module Views
+    class TabbedNavigation
+
+      # Overridden
+      def build_menu_item(item)
+        li id: item.id do |li|
+          li.add_class "current" if item.current?(assigns[:current_tab]) || item.current?(assigns[:current_sub_tab])
+
+          text_node link_to item.label(self), item.url(self), item.html_options
+
+          if children = item.items(self).presence
+            li.add_class "has_nested"
+            ul do
+              children.each{ |child| build_menu_item child }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/subnav/version.rb

@@ -0,0 +1,5 @@
+module Activeadmin
+  module Subnav
+    VERSION = "0.0.1"
+  end
+end

data/lib/active_admin/subnav/views/header_with_subnav.rb

@@ -0,0 +1,55 @@
+module ActiveAdmin
+  module Views
+    class HeaderWithSubnav < Component
+
+      def build(namespace, menu)
+        super(id: "header")
+
+        @namespace = namespace
+        @menu = menu
+        @utility_menu = @namespace.fetch_menu(:utility_navigation)
+
+        classes = Arbre::HTML::ClassList.new
+        classes << "navigation"
+        classes << "has_subnav" if has_sub_nav?
+
+        div class: classes do
+          build_site_title
+          build_global_navigation
+          build_utility_navigation
+        end
+
+        build_sub_navigation
+
+      end
+
+      def build_site_title
+        insert_tag view_factory.site_title, @namespace
+      end
+
+      def build_global_navigation
+        insert_tag view_factory.global_navigation, @menu, class: 'header-item tabs'
+      end
+
+      def build_sub_navigation
+        if has_sub_nav?
+          div class: "subnav" do
+            menu = active_admin_config.sub_navigation_menu
+            insert_tag view_factory.sub_navigation, menu, :class => "tabs"
+          end
+        end
+      end
+
+      def build_utility_navigation
+        insert_tag view_factory.utility_navigation, @utility_menu, id: "utility_nav", class: 'header-item tabs'
+      end
+
+      private
+
+      def has_sub_nav?
+        (active_admin_config.belongs_to? && !active_admin_config.has_nested_resources?) || active_admin_config.show_sub_menu?(params[:action])
+      end
+
+    end
+  end
+end

data/specs/subnav_spec.rb

@@ -0,0 +1,67 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/spec/expect'
+
+require 'active_admin/subnav'
+require 'sass-rails'
+
+class Minitest::SharedExamples < Module
+  include Minitest::Spec::DSL
+end
+
+ResourceMenuSpec = Minitest::SharedExamples.new do
+  it "to have sub navigation menu name accessor" do
+    expect(resource).to_respond_to :sub_navigation_menu_name
+    expect(resource).to_respond_to :sub_navigation_menu_name=
+  end
+
+  it "is a sub menu item when sub_navigation_menu_name is set" do
+    expect(resource.sub_menu_item?).to_equal false
+    resource.sub_navigation_menu_name = "Dashboard"
+    expect(resource.sub_menu_item?).to_equal true
+  end
+end
+
+describe "activeadmin-subnav" do
+  it "registers a sub navigation view" do
+    expect(ActiveAdmin::ViewFactory.new.default_for(:sub_navigation)).to_equal ActiveAdmin::Views::TabbedNavigation
+  end
+
+  it "registers a header with subn navigation" do
+    expect(ActiveAdmin::ViewFactory.new.default_for(:header)).to_equal ActiveAdmin::Views::HeaderWithSubnav
+  end
+
+  def namespace
+    app = ActiveAdmin::Application.new
+    app.namespace(:admin)
+  end
+
+  describe "extends ActiveAdmin::Namespace" do
+    it "adds sub menus" do
+      expect(namespace).to_respond_to :sub_menus
+    end
+  end
+
+  describe "extends Page" do
+    let(:page) { ActiveAdmin::Page.new(namespace, "Dashboard", {}) }
+    alias_method :resource, :page
+
+    include ResourceMenuSpec
+
+    it "to never show sub menus" do
+      expect(page.show_sub_menu?).to_equal false
+    end
+  end
+
+  describe "extends Resource" do
+    class Post; end
+    let(:resource) { ActiveAdmin::Resource.new(namespace, Post) }
+
+    include ResourceMenuSpec
+
+    it "to assign nested resources" do
+      resource.nested_resources = "nested"
+      expect(resource.has_nested_resources?).to_equal "nested"
+    end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: active_admin-subnav
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Charles Maresh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: minitest-spec-expect
+  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: sass-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'
+description: |
+  Currently, ActiveAdmin 1.0pre resets the top navigation menu to display the sub
+  navigation menu for all resources related to that parent resource. This gem
+  provides a sub navigation menu for those resources.
+email:
+- charles.maresh@orm-tech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_admin-subnav.gemspec
+- app/assets/stylesheets/active_admin/subnav.css.scss
+- lib/active_admin/subnav.rb
+- lib/active_admin/subnav/extensions/base_controller.rb
+- lib/active_admin/subnav/extensions/namespace.rb
+- lib/active_admin/subnav/extensions/page.rb
+- lib/active_admin/subnav/extensions/resource.rb
+- lib/active_admin/subnav/extensions/resource_menu.rb
+- lib/active_admin/subnav/extensions/tabbed_navigation.rb
+- lib/active_admin/subnav/version.rb
+- lib/active_admin/subnav/views/header_with_subnav.rb
+- specs/subnav_spec.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Provide sub-navigation menu for resources belonging to a parent resource.
+test_files: []
+has_rdoc: