link_to_action 0.2.5 → 0.3.0

data/README.md

@@ -7,6 +7,8 @@ Set of helpers: link_to_new, link_to_index, link_to_show, link_to_edit, link_to_
 
 Bonus helper: link_to_back
 
+Demo application sources with Twitter Bootstrap enabled: [link_to_action_demo](https://github.com/denispeplin/link_to_action_demo)
+
 ## Why
 
 Rails scaffold-generated links are not DRY, and it becomes even worse,
@@ -30,21 +32,21 @@ And scaffolded code was:
 ```
 
 Even in simple scaffolded link words 'edit' and 'comment' was repeated twice.
-In more complex example word 'edit' was written three times.
+In the more complex example word 'edit' was written three times.
 
-Using link_to_action gem, you can avoid those duplication completely:
+Using `link_to_action` gem, you can avoid those duplications completely:
 
 ```erb
 <%= link_to_edit @comment %>
 ```
 
-That's all for this link, but not all for this gem. It configurable, it can be
+That's all for this link, but not all for this gem. It is configurable, it can be
 tuned up to suit other than twitter-bootstrap CSS frameworks (which is off by
 default anyway), and it even can take advantage of cancan's abilities.
 
 ## When
 
-This gem is especially useful when application contains many simular-looking
+This gem is especially useful when an application contains many similar-looking
 links. Many global and link-specific options are exists, so this gem is flexible.
 And you still have `link_to` if you want some link to look really simple!
 
@@ -58,12 +60,17 @@ And then execute:
 
     $ bundle
 
-Add initializer and locale file:
+Add initializer, locale file and templates. Note that CSS classes, icons and
+cancan are disabled by default. To leave it as it is, just run:
 
     $ rails generate link_to_action:install
 
-Edit `config/initializers/link_to_action.rb`. Note that CSS classes, icons and
-cancan are disabled by default.
+Edit `config/initializers/link_to_action.rb` to change some options. The list of
+options with defaults provided below.
+
+To install `link_to_action` with Twitter Bootstrap and icons enabled, run:
+
+    $ rails generate link_to_action:install --bootstrap
 
 ## Usage
 
@@ -71,7 +78,8 @@ In general:
 
     link_to_{action} object, options
     
-Per action, with commented-out link_to equivalents:
+Per action, with commented-out link_to equivalents (no CSS or icons, just to
+keep it simple):
 
 ```ruby
 link_to_new MyModel # link_to 'New MyModel', new_my_model_path
@@ -83,7 +91,7 @@ link_to_destroy @my_model # link_to 'Delete MyModel', my_model_path(@my_model),
 link_to_back # link_to :back
 ```
 
-`link_to_show` tries some methods (by default :name, :title, and :to_s) to get
+`link_to_show` tries some methods (by default :name and :to_s) to get
 name for the link. This can be changed by specifying `i18n` option. Other
 helpers use I18n to get link names unless `name` option specified.
 
@@ -137,11 +145,11 @@ size_class_default = nil
 size_class_large = 'btn-large'
 size_class_small = 'btn-small'
 size_class_mini = 'btn-mini'
-show_methods = [ :name, :title, :to_s ]
+show_methods = [ :name, :to_s ]
 destroy_confirm = true
-destroy_skip_pjax = false
+destroy_skip_pjax = false # overwrite this if pjax is used
 ```
-Look to `config/initializers/link_to_action.rb` for detailed description.
+Look to `config/initializers/link_to_action.rb` for detailed descriptions.
 
 ## Per-link options
 
@@ -180,9 +188,14 @@ link_to_new [ @user, Comment ] # /users/1/comments/new
 
 ## TODO
 
-1. Add templates to change Rails scaffold templates.
-2. Better testing.
-3. Improve README, add more examples.
+1. Better testing.
+2. Improve README, add more examples.
+3. Add templates for Zurb Foundation.
+4. Whitespace fix in templates.
+
+## Credits
+
+This gem was heavily inspired by Platformatec's show_for and simple_form gems. Some code samples were taken from these gems.
 
 ## Contributing
 

data/lib/generators/link_to_action/install_generator.rb

@@ -6,9 +6,23 @@ module LinkToAction
     class InstallGenerator < Rails::Generators::Base
       desc "Copy LinkToAction configuration file"
       source_root File.expand_path('../templates', __FILE__)
+      class_option :bootstrap, type: :boolean,
+        desc: 'Add the Twitter Bootstrap option and templates.'
+
+      def info_framework
+        puts "link_to_action supports Twitter Bootstrap. If you want a " \
+          "configuration that is compatible with this framework, then please " \
+          "re-run this generator with --bootstrap option." unless options.bootstrap?
+      end
 
       def copy_initializers
         copy_file 'link_to_action.rb', 'config/initializers/link_to_action.rb'
+        if options[:bootstrap]
+          gsub_file 'config/initializers/link_to_action.rb',
+            %r|# config.use_icons = false|, 'config.use_icons = true'
+          gsub_file 'config/initializers/link_to_action.rb',
+            %r|# config.use_classes = false|, 'config.use_classes = true'
+        end
       end
 
       def copy_locale_file
@@ -17,11 +31,11 @@ module LinkToAction
       end
       
       def copy_templates
-        # TODO: one LOC
-        copy_file 'edit.html.erb', 'lib/templates/erb/scaffold/edit.html.erb'
-        copy_file 'index.html.erb', 'lib/templates/erb/scaffold/index.html.erb'
-        copy_file 'new.html.erb', 'lib/templates/erb/scaffold/new.html.erb'
-        copy_file 'show.html.erb', 'lib/templates/erb/scaffold/show.html.erb'
+        ['edit', 'index', 'new', 'show'].each do |action|
+          source_dir = 'bootstrap' if options[:bootstrap]
+          source_file = [ source_dir, "#{action}.html.erb"].compact.join('/')
+          copy_file source_file, "lib/templates/erb/scaffold/#{action}.html.erb"
+        end
       end
     end
   end

data/lib/generators/link_to_action/templates/bootstrap/edit.html.erb

@@ -0,0 +1,3 @@
+<h1>Editing <%= singular_table_name %></h1>
+
+<%%= render 'form' %>

data/lib/generators/link_to_action/templates/bootstrap/index.html.erb

@@ -0,0 +1,28 @@
+<h1>Listing <%= plural_table_name %></h1>
+
+<table class="table table-condensed">
+  <thead>
+    <tr>
+  <% attributes.each do |attribute| -%>
+      <th><%= attribute.human_name %></th>
+  <% end -%>
+      <th></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <%%= content_tag_for(:tr, @<%= plural_table_name %>) do |<%= singular_table_name %>| %>
+  <% attributes.each do |attribute| -%>
+    <% if attribute.name == 'name' %>
+      <td><%%= link_to_show <%= singular_table_name %> %></td>
+    <% else %>
+      <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+    <% end -%>
+  <% end -%>
+       <td><%%= link_to_edit <%= singular_table_name %>, size: :mini %>
+      <%%= link_to_destroy <%= singular_table_name %>, size: :mini %></td>
+    <%% end %>
+  </tbody>
+</table>
+
+<%%= link_to_new <%= class_name %> %>

data/lib/generators/link_to_action/templates/bootstrap/new.html.erb

@@ -0,0 +1,3 @@
+<h1>New <%= singular_table_name %></h1>
+
+<%%= render 'form' %>

data/lib/generators/link_to_action/templates/bootstrap/show.html.erb

@@ -0,0 +1,10 @@
+<% attributes.each do |attribute| -%>
+<p>
+  <strong><%= attribute.human_name %>:</strong>
+  <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+</p>
+
+<% end -%>
+
+<%%= link_to_edit @<%= singular_table_name %> %>
+<%%= link_to_back %>

data/lib/generators/link_to_action/templates/link_to_action.rb

@@ -44,7 +44,7 @@ LinkToAction.setup do |config|
 
   # Methods for link_to_show
   # config.show_methods = [ :name, :to_s ]
-  
+
   # Destroy link options
   # config.destroy_confirm = true
   # config.destroy_skip_pjax = false

data/lib/link_to_action/helpers.rb

@@ -63,11 +63,11 @@ module LinkToAction::Helpers
   private
   
   def link_to_action(action, object, options)
-    name = options.delete(:name) || LinkToAction::Utils::t_action(object, action)
+    name = options.delete(:name) || LinkToAction::Utils.t_action(object, action)
     params = options.delete(:params) || {}
     params[:action] = action if [ :new, :edit ].include? action
-    options[:class] = LinkToAction::Utils::action_class(action, options)
-    name = LinkToAction::Utils::add_icon_to_name(action, name, options)
+    options[:class] = LinkToAction::Utils.action_class(action, options)
+    name = LinkToAction::Utils.add_icon_to_name(action, name, options)
     if link_to_action_cancan?(action, object)
       link_to name, link_to_action_path(action, object, params), options
     end

data/lib/link_to_action/utils.rb

@@ -1,4 +1,6 @@
 module LinkToAction::Utils
+  module_function
+  
   def self.action_icon(action, options)
     icon = options.delete(:icon) || LinkToAction.send("icon_#{action}")
     icon_size = options.delete(:icon_size) || LinkToAction.icons_size

data/lib/link_to_action/version.rb

@@ -1,3 +1,3 @@
 module LinkToAction
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: link_to_action
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-22 00:00:00.000000000 Z
+date: 2012-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -90,6 +90,10 @@ files:
 - Rakefile
 - lib/generators/link_to_action/USAGE
 - lib/generators/link_to_action/install_generator.rb
+- lib/generators/link_to_action/templates/bootstrap/edit.html.erb
+- lib/generators/link_to_action/templates/bootstrap/index.html.erb
+- lib/generators/link_to_action/templates/bootstrap/new.html.erb
+- lib/generators/link_to_action/templates/bootstrap/show.html.erb
 - lib/generators/link_to_action/templates/edit.html.erb
 - lib/generators/link_to_action/templates/index.html.erb
 - lib/generators/link_to_action/templates/link_to_action.rb
@@ -162,7 +166,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2198198113135722753
+      hash: -2925219352894663217
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -171,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2198198113135722753
+      hash: -2925219352894663217
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23