active_admin-subnav 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c48d9e15942740b72a37b67dc9aa59a20687ad0f
-  data.tar.gz: 6df97455b50cc0015bde079189cc15e9b26095a4
+  metadata.gz: 956c5b117fae4020911254d663079fdf4c1c2162
+  data.tar.gz: edb905db6ef3a072af7ea9c96ab1a567042f7708
 SHA512:
-  metadata.gz: 14c65d77a8a5ee8af8a2a22b00d5d6f73a07448ace0abd68625ef907a5cee75e9cc7346e66edf3b70e1246a04667864edcd68525c4696d3bac39c88c0576b237
-  data.tar.gz: ce9920299f5832201c07aa03edf7788801a7d1a9f7b26f4338783333454f0603eb18b66fcc31bb1a68ee190bfc360f2f79f44a1528ab8b49edcfe0488738fc4e
+  metadata.gz: 9945683265bcf887314715a9412300c5bd960af8b580d541e53de1021b2e115bc57328e898627e7aab68ccac2553a28e75ff0f8c59032a0e2a646b3a5c9c0917
+  data.tar.gz: daec0b8998707d5f59a634bac08f9a99b9816f982e3156e5ef551c968233ad0249409459fccfcc0e29574893a39e516ce6c27df29b7018607fd84b04f25262ac

data/Changelog.md

@@ -0,0 +1,6 @@
+# Change Log
+
+## 1.0.0
+
+- Rename subnav.css.scss to subnav.scss to avoid Sprockets deprecation warning
+- No incompatible changes from v0.0.1

data/README.md

@@ -1,18 +1,71 @@
-# Activeadmin::Subnav
+# ActiveAdmin::Subnav
 
-Provide sub-navigation menu for resources belonging to a parent resource.
+[![Gem Version](https://badge.fury.io/rb/active_admin-subnav.svg)](http://badge.fury.io/rb/active_admin-subnav)
 
-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.
+## Description
 
-NOTE: Optional belongs_to configurations are not supported!
+Enhanced sub-navigation for nested ActiveAdmin resources.
+
+Currently, the base [ActiveAdmin][] install resets the top navigation menu to
+display the nested navigation menu, but it can be confusing to lose the main
+navigation context. This project keeps the main navigation visible and displays
+a secondary navigation bar for nested resources.
+
+**Note**: Optional belongs_to configurations are not supported!
+
+## Usage
+
+Resource `belongs_to` configuration does not require any extra configuration
+beyond the default. Below the Post resource belongs to Site.
+
+```ruby
+# admin/site.rb
+ActiveAdmin.register Site
+
+# admin/post.rb
+ActiveAdmin.register Post do
+  belongs_to :site
+end
+```
+
+Registering `belongs_to` pages requires more setup to properly access the
+parent record. This is a side effect of how [Arbre][] references parent
+HTML nodes. Below a new method, `#site`, is created to provide access to the
+parent record.
+
+```ruby
+# admin/site_statistics.rb
+ActiveAdmin.register_page "Statistics" do
+  belongs_to :site
+
+  content do
+    statistics = site.statistics
+    # ...
+  end
+
+  controller do
+
+    # Provide access to the parent resource record: Site.
+    #
+    # Without this extra setup the parent record will not be accessible. Any
+    # calls to `#parent` will return the Arbre parent element and not the
+    # ActiveAdmin resource.
+    alias_method :site, :parent
+
+    # Expose the method as a helper making it available to the view
+    helper_method :site
+
+  end
+end
+```
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'activeadmin-subnav'
+```ruby
+gem 'active_admin-subnav'
+```
 
 And then execute:
 
@@ -20,18 +73,28 @@ And then execute:
 
 Add the subnav's styles to your `active_admin.css.scss` stylesheet:
 
-    //= require active_admin/subnav
+```scss
+//= 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;
-    }
+// Align subnav with main navigation by padding the width of the site's
+// title.
+#header div.subnav {
+  padding-left: 8.333em;
+}
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/zorab47/activeadmin-subnav/fork )
+1. Fork it ( https://github.com/zorab47/active_admin-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
+ 
+## Versioning
+
+Follows [Semantic Versioning 2.0.0][Semver]
+
+[ActiveAdmin]: https://github.com/gregbell/active_admin
+[Semver]: http://semver.org/spec/v2.0.0.html
+[Arbre]: https://github.com/activeadmin/arbre

data/active_admin-subnav.gemspec

@@ -14,7 +14,7 @@ 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.homepage      = "https://github.com/zorab47/active_admin-subnav"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/active_admin/subnav/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_admin-subnav
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Charles Maresh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2016-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
@@ -105,12 +105,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Changelog.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - active_admin-subnav.gemspec
-- app/assets/stylesheets/active_admin/subnav.css.scss
+- app/assets/stylesheets/active_admin/subnav.scss
 - lib/active_admin/subnav.rb
 - lib/active_admin/subnav/extensions/base_controller.rb
 - lib/active_admin/subnav/extensions/namespace.rb
@@ -120,8 +121,8 @@ files:
 - 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: ''
+- spec/subnav_spec.rb
+homepage: https://github.com/zorab47/active_admin-subnav
 licenses:
 - MIT
 metadata: {}
@@ -141,9 +142,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Provide sub-navigation menu for resources belonging to a parent resource.
-test_files: []
-has_rdoc: 
+test_files:
+- spec/subnav_spec.rb