link_to_action 0.2.0 → 0.2.1

data/README.md

@@ -3,7 +3,7 @@
 
 # LinkToAction
 
-Set of helpers: link_to_new, link_to_edit, link_to_destroy
+Set of helpers: link_to_new, link_to_show, link_to_edit, link_to_destroy
 
 Bonus helper: link_to_back
 
@@ -12,25 +12,31 @@ Bonus helper: link_to_back
 Rails scaffold-generated links are not DRY, and it becomes even worse,
 when someone tries to make them I18n-friendly (they are not by default).
 
-If you have twitter-bootstrap installed, and want to make your links looks like
+If you have twitter-bootstrap installed, and want to make your links look like
 a buttons, there will be another addition, 'class' option. To make these buttons
 really pretty, you will also need icons.
 
 So how I18n-friendly button-style link with icon looks like in a view code?
 Well, it can look like this:
 
-    <%= link_to raw("<i class=\"icon-edit\"></i> #{t(:edit)}"), edit_comment_path(@comment), class: 'btn' %>
+```erb
+<%= link_to raw("<i class=\"icon-edit\"></i> #{t(:edit)}"), edit_comment_path(@comment), class: 'btn' %>
+```
 
 And scaffolded code was:
 
-    <%= link_to 'Edit', edit_comment_path(@comment) %>
+```erb
+<%= link_to 'Edit', edit_comment_path(@comment) %>
+```
 
 Even in simple scaffolded link words 'edit' and 'comment' was repeated twice.
 In more complex example word 'edit' was written three times.
 
 Using link_to_action gem, you can avoid those duplication completely:
 
-    link_to_edit @comment
+```erb
+<%= link_to_edit @comment %>
+```
 
 That's all for this link, but not all for this gem. It configurable, it can be
 tuned up to suit other than twitter-bootstrap CSS frameworks (which is off by
@@ -56,7 +62,7 @@ Add initializer:
 
     $ rails generate link_to_action:install
 
-Edit config/initializers/link_to_action.rb. Note that CSS classes, icons and
+Edit `config/initializers/link_to_action.rb`. Note that CSS classes, icons and
 cancan are disabled by default.
 
 ## Usage
@@ -65,12 +71,72 @@ In general:
 
     link_to_{action} object, options
     
-Per action:
-
-    link_to_new MyModel
-    link_to_edit @my_instance
-    link_to_destroy @my_instance
-    link_to_back
+Per action, with commented-out link_to equivalents:
+
+```ruby
+link_to_new MyModel # link_to 'New MyModel', new_my_model_path
+link_to_show @my_model # link_to @my_model.name, my_model_path(@my_model)
+link_to_edit @my_model # link_to 'Edit MyModel', edit_my_model_path(@my_model)
+link_to_destroy @my_model # link_to 'Delete MyModel', my_model_path(@my_model),
+# method: :delete, data: { confirm: 'Are you sure?' }
+link_to_back # link_to :back
+```
+
+`link_to_show` tries some methods (by default :name, :title, and :to_s) to get
+name for the link. Other helpers uses I18n to get link names.
+
+## I18n
+
+`link_to_action` comes with I18n preconfigured, nested in `helpers.link_to`
+section. Custom (or localized) model names can be added to `activerecord.models`
+section.
+
+```yml
+en:
+  activerecord:
+    models:
+      my_model: 'My Awesome Model'
+  helpers:
+    link_to:
+      new: 'New %{model}'
+      edit: 'Edit %{model}'
+      destroy: 'Delete %{model}'
+      destroy_confirm: 'Are you sure?'
+      back: 'Back'
+```
+
+## Global CSS styles and icons
+
+Look to `config/initializers/link_to_action.rb` for global options. Cancan also
+goes here.
+
+## Per-link options
+
+```ruby
+:name # overwrites default name of the link
+:class # overwrites or appends class list
+:size # size of the button-like link
+:params # hash for to polymorphic_path, see examples
+:icon # Font-Awesome icon
+:icon_size # Size of icon
+:icon_swap # Swap default position of icon left-right
+```
+
+`link_to_show` options:
+```ruby
+:name # overwrites default name of the link
+:send # method to sent to object to get name
+```
+
+Examples
+
+```ruby
+# Link with parameters
+link_to_new Comment, params: {user_id: 1} # /comments/new?user_id=1
+
+# Nested link
+link_to_new [ @user, Comment ] # /users/1/comments/new
+```
 
 ## Contributing
 

data/lib/generators/link_to_action/install_generator.rb

@@ -10,6 +10,10 @@ module LinkToAction
       def copy_initializers
         copy_file 'link_to_action.rb', 'config/initializers/link_to_action.rb'
       end
+
+      def copy_locale_file
+        copy_file 'en.yml', 'config/locales/link_to_action.en.yml'
+      end
     end
   end
 end

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

@@ -38,4 +38,7 @@ LinkToAction.setup do |config|
   # config.size_class_large = 'btn-large'
   # config.size_class_small = 'btn-small'
   # config.size_class_mini = 'btn-mini'
+
+  # Methods for link_to_show
+  # config.show_methods = [ :name, :title, :to_s ]
 end

data/lib/link_to_action/helpers.rb

@@ -20,6 +20,16 @@ module LinkToAction::Helpers
     link_to_action :back, nil, options
   end
 
+  def link_to_show(object, options = {})
+    name = options.delete(:name)
+    send = options.delete(:send)
+    name = object.send(send) if send
+    LinkToAction.show_methods.each do |m|
+      name = object.try(m) unless name
+    end
+    link_to name, object, options
+  end
+
   # TODO: Move to separate module to avoid clashes
   private
 
@@ -34,11 +44,11 @@ module LinkToAction::Helpers
       classes = if LinkToAction.classes_append
         classes.concat [ options[:class] ]
       else
-        options[:class]
+        [ options[:class] ]
       end
     end
-    classes = [ classes ,size_class(size) ].flatten.compact.join(' ')
-    classes.strip unless classes.blank?
+    classes = classes.concat([ size_class(size) ]).compact.join(' ')
+    classes unless classes.blank?
   end
 
   def size_class(size)

data/lib/link_to_action/version.rb

@@ -1,3 +1,3 @@
 module LinkToAction
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/link_to_action.rb

@@ -62,6 +62,10 @@ module LinkToAction
 
   mattr_accessor :size_class_mini
   @@size_class_mini = 'btn-mini'
+
+  mattr_accessor :show_methods
+  @@show_methods = [ :name, :title, :to_s ]
+
   def self.setup
     yield self
   end

data/test/default_values_test.rb

@@ -21,6 +21,7 @@ class DefaultValuesTest < ActiveSupport::TestCase
     size_class_large: 'btn-large',
     size_class_small: 'btn-small',
     size_class_mini: 'btn-mini',
+    show_methods: [ :name, :title, :to_s ]
   }
 
   DEFAULT_VALUES.each do |key, value|

data/test/dummy/db/migrate/20121005032141_add_login_to_users.rb

@@ -0,0 +1,5 @@
+class AddLoginToUsers < ActiveRecord::Migration
+  def change
+    add_column :users, :login, :string
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20121003103958) do
+ActiveRecord::Schema.define(:version => 20121005032141) do
 
   create_table "comments", :force => true do |t|
     t.string   "name"
@@ -26,6 +26,7 @@ ActiveRecord::Schema.define(:version => 20121003103958) do
     t.string   "name"
     t.datetime "created_at", :null => false
     t.datetime "updated_at", :null => false
+    t.string   "login"
   end
 
 end

data/test/helpers_test.rb

@@ -11,6 +11,16 @@ class HelperTest < ActionView::TestCase
       link_to_new([@user, Comment])
   end
 
+  test 'link_to_show' do
+    assert_equal "<a href=\"/users/1\">#{@user.name}</a>",
+      link_to_show(@user)
+  end
+  
+  test 'link_to_show using custom method' do
+    assert_equal "<a href=\"/users/1\">#{@user.login}</a>",
+      link_to_show(@user, send: :login)
+  end
+
   test 'link_to_edit' do
     assert_equal "<a href=\"/users/1/edit\">Edit My User</a>", link_to_edit(@user)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: link_to_action
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-04 00:00:00.000000000 Z
+date: 2012-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &20622580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 3.2.8
   type: :development
   prerelease: false
-  version_requirements: *20622580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &20640700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20640700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &20652780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20652780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &20650660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20650660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: link_to for specific actions
 email:
 - denis.peplin@gmail.com
@@ -107,6 +127,7 @@ files:
 - test/dummy/config/routes.rb
 - test/dummy/db/migrate/20121003103906_create_users.rb
 - test/dummy/db/migrate/20121003103958_create_comments.rb
+- test/dummy/db/migrate/20121005032141_add_login_to_users.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
 - test/dummy/lib/assets/.gitkeep
@@ -120,8 +141,6 @@ files:
 - test/link_to_action_test.rb
 - test/support/misc_helpers.rb
 - test/test_helper.rb
-- test/dummy/log/development.log
-- test/dummy/log/test.log
 homepage: https://github.com/denispeplin/link_to_action
 licenses: []
 post_install_message: 
@@ -136,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2755518087987160038
+      hash: 1452578497091669240
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -145,53 +164,52 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2755518087987160038
+      hash: 1452578497091669240
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Links to actions
 test_files:
-- test/support/misc_helpers.rb
 - test/helpers_test.rb
+- test/link_to_action_test.rb
 - test/test_helper.rb
+- test/support/misc_helpers.rb
+- test/dummy/config.ru
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/favicon.ico
+- test/dummy/public/500.html
+- test/dummy/script/rails
 - test/dummy/README.rdoc
-- test/dummy/config/routes.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/environment.rb
+- test/dummy/config/environments/test.rb
 - test/dummy/config/environments/development.rb
 - test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/application.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/link_to_action.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/database.yml
+- test/dummy/config/locales/en.yml
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/link_to_action.rb
 - test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/database.yml
-- test/dummy/Rakefile
-- test/dummy/config.ru
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/controllers/application_controller.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/models/comment.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/models/user.rb
-- test/dummy/log/development.log
-- test/dummy/log/test.log
+- test/dummy/app/models/comment.rb
+- test/dummy/Rakefile
 - test/dummy/db/test.sqlite3
-- test/dummy/db/schema.rb
-- test/dummy/db/migrate/20121003103906_create_users.rb
 - test/dummy/db/migrate/20121003103958_create_comments.rb
-- test/dummy/public/422.html
-- test/dummy/public/404.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/script/rails
+- test/dummy/db/migrate/20121003103906_create_users.rb
+- test/dummy/db/migrate/20121005032141_add_login_to_users.rb
+- test/dummy/db/schema.rb
 - test/default_values_test.rb
-- test/link_to_action_test.rb

data/test/dummy/log/development.log

@@ -1,25 +0,0 @@
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-   (0.1ms)  select sqlite_version(*)
-   (4.3ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
-   (0.0ms)  PRAGMA index_list("schema_migrations")
-   (1.5ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
-   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
-Migrating to CreateUsers (20121003103906)
-   (0.0ms)  begin transaction
-   (0.7ms)  CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
-   (0.3ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20121003103906')
-   (1.6ms)  commit transaction
-Migrating to CreateComments (20121003103958)
-   (0.1ms)  begin transaction
-   (0.3ms)  CREATE TABLE "comments" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "user_id" integer, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
-   (0.0ms)  PRAGMA index_list("comments")
-   (0.1ms)  CREATE INDEX "index_comments_on_user_id" ON "comments" ("user_id")
-   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20121003103958')
-   (1.4ms)  commit transaction
-   (0.2ms)  select sqlite_version(*)
-   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
-   (0.0ms)  PRAGMA index_list("comments")
-   (0.0ms)  PRAGMA index_info('index_comments_on_user_id')
-   (0.0ms)  PRAGMA index_list("users")