adminlte-generators 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff05ee523693517ca3b146b8c90a8bd360c235fb
-  data.tar.gz: d80b1e94569cb6c6fc528a50573df140d243f617
+  metadata.gz: 3eea011223e5c1fbbe87cbd330931d43c29a7d96
+  data.tar.gz: 503eb833c0df8b24df7716b04524d8130d5caa56
 SHA512:
-  metadata.gz: c3021010ed57d086d81bccbb1a0f8c9c1b476e61abc6494af078b8a71fd4c1858b1a722260f3c9b0b4ec24ce3ea7a081852afc04f9793a562b6373e50cb9392b
-  data.tar.gz: e714d49bd0ad571eed48cb34b0eeeb371c212a323724b27aff6d83c4157836083339d60bf1d7544f6735f349fce5ab3832ea93989ad2abd22a24f39f06c4c6d2
+  metadata.gz: 107aa4856362bdce021814c6b0f60d529cb711feae6b18b311813077991b36a70597d1766a695721af5d5374f6f66557fc0f34143731f07199eb9899f1b971ad
+  data.tar.gz: 0b0a54d013fc86319adaa1b29d3a775a7e8a91a5ab9056f438f376d7622df847ad86e0933042655db1d8b7c238b9afcf02f03a2329902c00e1f18c413a49344d

data/README.md

@@ -5,7 +5,7 @@ AdminLTE is a rich [Twitter Bootstrap](http://getbootstrap.com/) admin template.
 
 ## Installation
 
-Add this line to your application's Gemfile (you'll need (adminlte)[https://github.com/chukcha-wtf/adminlte] gem installed):
+Add this line to your application's Gemfile, you'll need (adminlte)[https://github.com/chukcha-wtf/adminlte] gem installed:
 
 ```ruby
 gem 'adminlte'
@@ -46,18 +46,44 @@ You could provide a name for generated layout (usefull if you've got few layouts
 
 Simply run:
 
-    rails generate bootstrap:install --layout_name=admin
+    rails generate adminlte:install --layout_name=admin
 
 #### Default skin
 
 AdminLTE comes with **blue** skin by default. If you wish to change it to **black** just run:
 
-    rails generate bootstrap:install --skin=black
+    rails generate adminlte:install --skin=black
 
 #### Skip turbolinks
 
 Run the generator with option `--skip-turbolinks` to remove turbolinks references from the generated layout.
 
+## Helpers
+Oh, btw you'll get 2 navigation helpers for free.
+
+For sidebar links you could use `nav_link` helper:
+
+```ruby
+  <%= nav_link root_path do %>
+    <i class="fa fa-dashboard"></i> <span>Dashboard</span>
+  <% end %>
+```
+
+And if you want to create a treeview, just use `treeview_link` helper:
+
+```ruby
+  <%= treeview_link 'Lots of links here' do %>
+    <%= nav_link you_shall_not_path do %>
+      <i class="fa fa-angle-double-right"></i>
+      One Way
+    <% end %>
+    <%= nav_link you_shall__path do %>
+      <i class="fa fa-angle-double-right"></i>
+      Another
+    <% end %>
+  <% end %>
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/adminlte-generators/fork )
@@ -66,5 +92,11 @@ Run the generator with option `--skip-turbolinks` to remove turbolinks reference
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+## Credits
+
+* [AdminLTE](http://almsaeedstudio.com/AdminLTE)
+* [bootstrap-generators](https://github.com/decioferreira/bootstrap-generators)
+
+
 ## TODO:
 Write tests for generators

data/lib/adminlte-generators.rb

@@ -2,7 +2,7 @@ require "rails"
 
 module Adminlte
   module Generators
-    class Engine < ::Rails::Engine
+    class Engine < Rails::Engine
       config.app_generators.stylesheets false
 
       initializer 'adminlte-generators.setup', group: :all do |app|
@@ -10,6 +10,10 @@ module Adminlte
 
         app.config.assets.precompile << /\.(?:svg|eot|woff|ttf)$/
       end
+
+      config.app_generators do |g|
+        g.templates.unshift File::expand_path('../templates', __FILE__)
+      end
     end
   end
 end

data/lib/adminlte/generators/version.rb

@@ -1,5 +1,5 @@
 module Adminlte
   module Generators
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/generators/adminlte/install/install_generator.rb

@@ -20,6 +20,10 @@ module Adminlte
         copy_file "form_builder/_form.html.#{options[:template_engine]}", "lib/templates/#{options[:template_engine]}/scaffold/_form.html.#{options[:template_engine]}" 
       end
 
+      def copy_nav_helper
+        copy_file "helpers/navigation_helper.rb", "app/helpers/nav_helper.rb"
+      end
+
       def create_layout
         template "layouts/dashboard.html.#{options[:template_engine]}", "app/views/layouts/#{options[:layout_name]}.html.#{options[:template_engine]}"
         template "layouts/_header.html.#{options[:template_engine]}", "app/views/layouts/_#{options[:layout_name]}_header.html.#{options[:template_engine]}"

data/lib/generators/adminlte/install/templates/helpers/navigation_helper.rb

@@ -0,0 +1,26 @@
+module NavHelper
+  def nav_link(page, &link_text) 
+    class_name = request.env['PATH_INFO'].match(page) ? 'active' : nil
+
+    content_tag(:li, class: class_name) do
+      link_to page do
+        link_text.call
+      end
+    end
+  end
+
+  def treeview_link(text, &links)
+    content = link_to('#') do
+      content_tag(:span, text) <<
+      content_tag(:i, '', class: "fa pull-right fa-angle-left")
+    end
+
+    content << content_tag(:ul, class: 'treeview-menu') do 
+      links.call
+    end
+
+    content_tag :li, class: 'treeview' do
+      content
+    end
+  end
+end

data/lib/generators/adminlte/install/templates/layouts/_sidebar.html.erb

@@ -22,22 +22,18 @@
   <!-- /.search form -->
   <!-- sidebar menu: : style can be found in sidebar.less -->
   <ul class="sidebar-menu">
-    <li class="active">
-      <a href="#">
-        <i class="fa fa-dashboard"></i> <span>Dashboard</span>
-      </a>
-    </li>
-    <li class="treeview">
-      <a href="#">
-        <i class="fa fa-bar-chart-o"></i>
-        <span>Charts</span>
-        <i class="fa fa-angle-left pull-right"></i>
-      </a>
-      <ul class="treeview-menu">
-        <li><a href="#"><i class="fa fa-angle-double-right"></i> Morris</a></li>
-        <li><a href="#"><i class="fa fa-angle-double-right"></i> Flot</a></li>
-        <li><a href="#"><i class="fa fa-angle-double-right"></i> Inline charts</a></li>
-      </ul>
-    </li>
+    <%%= nav_link root_path do %>
+      <i class="fa fa-dashboard"></i> <span>Dashboard</span>
+    <%% end %>
+    <%%= treeview_link 'Lots of links here' do %>
+      <%%= nav_link "#" do %>
+        <i class="fa fa-angle-double-right"></i>
+        One Way
+      <%% end %>
+      <%%= nav_link "#" do %>
+        <i class="fa fa-angle-double-right"></i>
+        Another
+      <%% end %>
+    <%% end %>
   </ul>
 </section>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adminlte-generators
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Pavlo Babenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ files:
 - lib/generators/adminlte/install/templates/assets/stylesheets/adminlte_overrides.css
 - lib/generators/adminlte/install/templates/assets/stylesheets/adminlte_overrides.scss
 - lib/generators/adminlte/install/templates/form_builder/_form.html.erb
+- lib/generators/adminlte/install/templates/helpers/navigation_helper.rb
 - lib/generators/adminlte/install/templates/layouts/_header.html.erb
 - lib/generators/adminlte/install/templates/layouts/_sidebar.html.erb
 - lib/generators/adminlte/install/templates/layouts/dashboard.html.erb