cancan-rest-links 0.2.0 → 0.2.1

data/README.markdown

@@ -2,15 +2,14 @@
 
 REST link helpers for the [CanCan](http://github.com/ryanb/cancan) permission system.
 
-## Update:Nov 26, 2010
+## Rails 3 install
 
-From changelog:
+in Gemfile insert:
+<pre>
+gem 'cancan-rest-links'  
+</pre>
 
-* Removed dependency to Cream for labels
-* Created class methods on CanCan::Links::Rest for handling labels, including translations
-* Created a Generator to create a locale file for labels
-* Created a spec to test the generator
-* Created specs to test the REST link generation with and without label translations
+Then run <code>$ bundle install</code> from the terminal.
 
 ## Rails 3 usage
 
@@ -18,10 +17,81 @@ See the demo app at [CanCan permits demo app](https://github.com/kristianmandrup
 
 Configure your Rails 3 app for use with CanCan and some Authentication solution like Authlogic or Devise.
 
+This locale file should be placed in config/locales in your Rails 3 app. The generator will create the above locale file as _cream.en.yml_
+
 ## Use with CanCan permits
 
 [CanCan permits](https://github.com/kristianmandrup/cancan-permits) is a gem that lets you use Permits with CanCan to configure permissions.
 
+## REST links
+
+These REST link helpers always check the _current_user_ to see if the user has the required permission access for the required action on the given model. If not, the link is not rendered.
+
+The following is a list of the REST links available and the required CanCan permission level for the model instance(s) that is linked to. 
+Note that the CanCan _:manage_ level implies full permission and _:write_ full mutation access.
+
+* Index :read
+* Show :read
+* Create :create
+* Edit :edit
+* Delete :destroy
+
+Typically the REST links are used within views, partials and view helpers. Example
+
+<pre>
+<%= index_link(Post, 'To the posts') %>
+<%= create_link(Post, 'Create a new post') %>
+</pre>
+
+For the create and index REST actions, you can pass either an instance or a class of a model object. The other REST options only work with model instances. 
+
+### index_link
+
+<pre>index_link(Post)
+index_link(Post, 'To the posts')
+index_link(@post)
+index_link(@post, 'All the posts')
+</pre>
+
+### create_link
+
+<pre>create_link(Post)
+create_link(Post, 'Create the post')
+create_link(@post)
+create_link(@post, 'Create the post')</pre>
+
+### edit_link
+
+<pre>edit_link(@post)
+edit_link(@post, 'Edit the post')</pre>
+
+### delete_link
+
+<pre>delete_link(@post)
+delete_link(@post, 'Delete the post')</pre>
+
+### show_link
+
+<pre>show_link(@post)
+show_link(@post, 'Show the post')</pre>
+
+## Locale file
+
+A locale file with the following structure can be created to define define labels for the various REST actions.
+
+<pre>
+en:
+  cream:
+    confirm: 'Are you sure?'
+    actions:
+      rest:  
+        index: "Index"
+        new: "New"
+        edit: "Edit"
+        delete: "Delete"
+        show: "Show"  
+</pre>
+
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -9,12 +9,12 @@ begin
     gem.authors = ["Kristian Mandrup"]
     gem.add_development_dependency "rspec",             ">= 2.0.0"
     gem.add_development_dependency "rspec-action_view", ">= 0.3.4"
+    gem.add_development_dependency 'generator-spec',    ">= 0.7.0"
 
     gem.add_dependency 'cancan',            "~> 1.4.0"
     gem.add_dependency 'require_all',       "~> 1.2.0"
     gem.add_dependency 'sugar-high',        "~> 0.3.0"
-    gem.add_dependency 'r3_plugin_toolbox', ">= 0.4.0"     
-    gem.add_dependency 'generator-spec',    ">= 0.7.0"
+    gem.add_dependency 'r3_plugin_toolbox', ">= 0.4.0"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/cancan-rest-links.gemspec

@@ -1,61 +1,59 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{cancan-rest-links}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-11-26}
+  s.date = %q{2010-12-23}
   s.description = %q{Guard your links with permissions}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.markdown"
+    "README.markdown"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     ".rspec",
-     "Changelog.txt",
-     "Gemfile",
-     "Ideas and Planning.txt",
-     "LICENSE",
-     "README.markdown",
-     "Rakefile",
-     "VERSION",
-     "cancan-rest-links.gemspec",
-     "lib/cancan-rest-links.rb",
-     "lib/cancan-rest-links/labels.rb",
-     "lib/cancan-rest-links/namespaces.rb",
-     "lib/cancan-rest-links/rails/configure.rb",
-     "lib/cancan-rest-links/rest_links.rb",
-     "lib/generators/cancan/restlinks/restlinks_generator.rb",
-     "lib/generators/cancan/restlinks/templates/en.yml",
-     "log/development.log",
-     "sandbox/link_with_cream_spec.rb",
-     "spec/cancan-rest-links/generators/restlinks_generator.rb",
-     "spec/cancan-rest-links/rails/configure_spec.rb",
-     "spec/cancan-rest-links/rest_links_default_spec.rb",
-     "spec/cancan-rest-links/rest_links_translate_spec.rb",
-     "spec/cancan-rest-links/translate_spec.rb",
-     "spec/spec_helper.rb"
+    ".rspec",
+    "Changelog.txt",
+    "Gemfile",
+    "Ideas and Planning.txt",
+    "LICENSE",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "cancan-rest-links.gemspec",
+    "lib/cancan-rest-links.rb",
+    "lib/cancan-rest-links/labels.rb",
+    "lib/cancan-rest-links/namespaces.rb",
+    "lib/cancan-rest-links/rails/configure.rb",
+    "lib/cancan-rest-links/rest_links.rb",
+    "lib/generators/cancan/restlinks/restlinks_generator.rb",
+    "lib/generators/cancan/restlinks/templates/restlinks.en.yml",
+    "log/development.log",
+    "sandbox/link_with_cream_spec.rb",
+    "spec/cancan-rest-links/generators/restlinks_generator.rb",
+    "spec/cancan-rest-links/rails/configure_spec.rb",
+    "spec/cancan-rest-links/rest_links_default_spec.rb",
+    "spec/cancan-rest-links/rest_links_translate_spec.rb",
+    "spec/cancan-rest-links/translate_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/kristianmandrup/cancan-rest-links}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Rest link helpers for CanCan}
   s.test_files = [
     "spec/cancan-rest-links/generators/restlinks_generator.rb",
-     "spec/cancan-rest-links/rails/configure_spec.rb",
-     "spec/cancan-rest-links/rest_links_default_spec.rb",
-     "spec/cancan-rest-links/rest_links_translate_spec.rb",
-     "spec/cancan-rest-links/translate_spec.rb",
-     "spec/spec_helper.rb"
+    "spec/cancan-rest-links/rails/configure_spec.rb",
+    "spec/cancan-rest-links/rest_links_default_spec.rb",
+    "spec/cancan-rest-links/rest_links_translate_spec.rb",
+    "spec/cancan-rest-links/translate_spec.rb",
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -63,30 +61,42 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<cancan>, ["~> 1.4.0"])
+      s.add_runtime_dependency(%q<require_all>, ["~> 1.2.0"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.0"])
+      s.add_runtime_dependency(%q<r3_plugin_toolbox>, ["~> 0.4.0"])
       s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
       s.add_development_dependency(%q<rspec-action_view>, [">= 0.3.4"])
+      s.add_development_dependency(%q<generator-spec>, [">= 0.7.0"])
       s.add_runtime_dependency(%q<cancan>, ["~> 1.4.0"])
       s.add_runtime_dependency(%q<require_all>, ["~> 1.2.0"])
       s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.0"])
       s.add_runtime_dependency(%q<r3_plugin_toolbox>, [">= 0.4.0"])
-      s.add_runtime_dependency(%q<generator-spec>, [">= 0.7.0"])
     else
+      s.add_dependency(%q<cancan>, ["~> 1.4.0"])
+      s.add_dependency(%q<require_all>, ["~> 1.2.0"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
+      s.add_dependency(%q<r3_plugin_toolbox>, ["~> 0.4.0"])
       s.add_dependency(%q<rspec>, [">= 2.0.0"])
       s.add_dependency(%q<rspec-action_view>, [">= 0.3.4"])
+      s.add_dependency(%q<generator-spec>, [">= 0.7.0"])
       s.add_dependency(%q<cancan>, ["~> 1.4.0"])
       s.add_dependency(%q<require_all>, ["~> 1.2.0"])
       s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
       s.add_dependency(%q<r3_plugin_toolbox>, [">= 0.4.0"])
-      s.add_dependency(%q<generator-spec>, [">= 0.7.0"])
     end
   else
+    s.add_dependency(%q<cancan>, ["~> 1.4.0"])
+    s.add_dependency(%q<require_all>, ["~> 1.2.0"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
+    s.add_dependency(%q<r3_plugin_toolbox>, ["~> 0.4.0"])
     s.add_dependency(%q<rspec>, [">= 2.0.0"])
     s.add_dependency(%q<rspec-action_view>, [">= 0.3.4"])
+    s.add_dependency(%q<generator-spec>, [">= 0.7.0"])
     s.add_dependency(%q<cancan>, ["~> 1.4.0"])
     s.add_dependency(%q<require_all>, ["~> 1.2.0"])
     s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
     s.add_dependency(%q<r3_plugin_toolbox>, [">= 0.4.0"])
-    s.add_dependency(%q<generator-spec>, [">= 0.7.0"])
   end
 end
 

data/lib/cancan-rest-links/labels.rb

@@ -25,7 +25,7 @@ module CanCan::Links
       end    
 
       def translate_labels
-        ns_actions = 'cream.actions'
+        ns_actions = 'cream.actions.rest'
         tlabels =rest_labels.inject({}) {|result, action| 
           result[action.to_sym] = t("#{ns_actions}.#{action}").humanize
           result

data/lib/generators/cancan/restlinks/restlinks_generator.rb

@@ -7,7 +7,7 @@ require 'logging_assist'
 module Cancan
   module Generators
     class RestlinksGenerator < Rails::Generators::Base
-      desc "Configures Rails app for use with RestLinks"
+      desc "Configures Rails app for use with CanCan REST links"
 
       source_root File.dirname(__FILE__) + '/templates'
 
@@ -21,7 +21,7 @@ module Cancan
       # extend Rails3::Assist::UseMacro
   
       def copy_locale  
-        template "en.yml", "config/locales/cream.en.yml"
+        template "restlinks.en.yml", "config/locales/cream.en.yml"
       end
     end
   end

data/lib/generators/cancan/restlinks/templates/restlinks.en.yml

@@ -0,0 +1,10 @@
+en:
+  cream:
+    confirm: 'Are you sure?'
+    actions:
+      rest:  
+        index: "Index"
+        new: "New"
+        edit: "Edit"
+        delete: "Delete"
+        show: "Show"

data/spec/cancan-rest-links/generators/restlinks_generator.rb

@@ -13,9 +13,9 @@ end
 
 
 describe 'Restlinks generator' do   
-  use_helpers :controller, :special, :file
+  use_helpers :special, :file
     
-  setup_generator :licenses do
+  setup_generator :cancan_rest_links do
     tests Cancan::Generators::RestlinksGenerator
   end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,13 +14,72 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-26 00:00:00 +01:00
+date: 2010-12-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
+  name: cancan
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: require_all
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sugar-high
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: r3_plugin_toolbox
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,11 +90,11 @@ dependencies:
         - 0
         version: 2.0.0
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rspec-action_view
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,11 +105,26 @@ dependencies:
         - 4
         version: 0.3.4
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: cancan
+  name: generator-spec
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 0
+        version: 0.7.0
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: cancan
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -61,11 +135,11 @@ dependencies:
         - 0
         version: 1.4.0
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: require_all
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -76,11 +150,11 @@ dependencies:
         - 0
         version: 1.2.0
   type: :runtime
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: sugar-high
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -91,11 +165,11 @@ dependencies:
         - 0
         version: 0.3.0
   type: :runtime
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: r3_plugin_toolbox
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -106,22 +180,8 @@ dependencies:
         - 0
         version: 0.4.0
   type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: generator-spec
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 7
-        - 0
-        version: 0.7.0
-  type: :runtime
-  version_requirements: *id007
+  version_requirements: *id011
 description: Guard your links with permissions
 email: kmandrup@gmail.com
 executables: []
@@ -133,7 +193,6 @@ extra_rdoc_files:
 - README.markdown
 files: 
 - .document
-- .gitignore
 - .rspec
 - Changelog.txt
 - Gemfile
@@ -149,7 +208,7 @@ files:
 - lib/cancan-rest-links/rails/configure.rb
 - lib/cancan-rest-links/rest_links.rb
 - lib/generators/cancan/restlinks/restlinks_generator.rb
-- lib/generators/cancan/restlinks/templates/en.yml
+- lib/generators/cancan/restlinks/templates/restlinks.en.yml
 - log/development.log
 - sandbox/link_with_cream_spec.rb
 - spec/cancan-rest-links/generators/restlinks_generator.rb
@@ -163,8 +222,8 @@ homepage: http://github.com/kristianmandrup/cancan-rest-links
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC

data/lib/generators/cancan/restlinks/templates/en.yml

@@ -1,9 +0,0 @@
-en:
-  cream:
-    confirm: 'Are you sure?'
-    actions:  
-      index: "Index"
-      new: "New"
-      edit: "Edit"
-      delete: "Delete"
-      show: "Show"