devise-links 0.1.5 → 0.2.0

data/Changelog.txt

@@ -0,0 +1,5 @@
+Nov 26, 2010
+---
+Major update to make the gem independent of Cream
+* Removed dependency on #auth_labels method in Cream, now uses internal #labels method
+* Added devise:links generator that can generate a 'cream' locale file for the labels used

data/README.markdown

@@ -12,29 +12,50 @@ Alternatively insert into Rails 3 Gemfile:
   gem 'devise-links'
 </pre>
 
-and from the terminal run: *bundle install*
+Run <code>$ bundle install</code> in terminal from root of Rails app
+
+## Updates
+
+See 'Changelog.txt'
+
+_Nov 26, 2010_
+
+Major update to make the gem independent of Cream
+
+* Removed dependency on #auth_labels method in Cream, now uses internal #labels method
+* Added devise:links generator that can generate a 'cream' locale file for the labels used
 
 ## Usage
 
+The gem adds a set of convenient view helpers that are available inside any Rails view:
+
 <pre>
-  <%= new_registration_link(:role => :admin) %>
-  
+  <%= new_registration_link(:role => :admin) %>  
   <%= sign_out_link(:role => :admin, :label => 'Log me out!') %>
 </pre>
 
+## Generators
+
+Running the devise:links generator should generate a locale file called 'cream.en.yml' in your Rails app /locales dir.
+
+<code>rails g devise:links</code>
+
+To enable i18n (translations), please set <code>Devise::Links.translate = true</code> fx in a Rails initializer file.
+
+## Contributions and more info
+
+See specs for demonstrations of how to use the API etc. To contribute, please enhance by writing specs and then adjusting/enhancing the functionality
+
 ## TODO
 
 Make API more generic...
 
 <pre>
-  <%= new_registration_link(:admin) %>
-  
-  <%= sign_out_link(:admin, 'Log out') %>
-  
+  <%= new_registration_link(:admin) %>  
+  <%= sign_out_link(:admin, 'Log out') %>  
   <%= new_registration_link('Register!') %>  
 </pre>
 
-
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -7,13 +7,18 @@ begin
     gem.email = "kmandrup@gmail.com"
     gem.homepage = "http://github.com/kristianmandrup/devise-links"
     gem.authors = ["Kristian Mandrup"]
-    gem.add_development_dependency "rspec",               ">= 2.0.0.rc"
-    gem.add_development_dependency "rspec-action_view",   "~> 0.3.1"
+    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 "devise",              ">= 1.1.2"
+    gem.add_dependency "devise",              ">= 1.2"
+    gem.add_dependency 'activesupport',       ">= 3.0.0"
     gem.add_dependency 'require_all',         "~> 1.2.0"
-    gem.add_dependency 'sugar-high',          "~> 0.2.10"     
-    gem.add_dependency 'r3_plugin_toolbox',   "~> 0.3.6"      
+    gem.add_dependency 'sugar-high',          "~> 0.3.0"
+    gem.add_dependency 'r3_plugin_toolbox',   ">= 0.4.0" 
+    gem.add_dependency 'rails3_artifactor',   ">= 0.3.1" 
+    gem.add_dependency 'logging_assist',      "~> 0.1.6"
+
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.2.0

data/devise-links.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{devise-links}
-  s.version = "0.1.5"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-10-07}
+  s.date = %q{2010-11-26}
   s.description = %q{Link helpers for Devise actions, including user session and registration links.}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -20,19 +20,25 @@ Gem::Specification.new do |s|
     ".document",
      ".gitignore",
      ".rspec",
+     "Changelog.txt",
      "LICENSE",
      "README.markdown",
      "Rakefile",
      "VERSION",
      "devise-links.gemspec",
      "lib/devise-links.rb",
-     "lib/devise-links/link/registration.rb",
-     "lib/devise-links/link/session.rb",
+     "lib/devise-links/labels.rb",
      "lib/devise-links/namespaces.rb",
      "lib/devise-links/rails/configure.rb",
-     "spec/devise-links/helpers/registration-links_spec.rb",
-     "spec/devise-links/helpers/session_links_spec.rb",
+     "lib/devise-links/registration.rb",
+     "lib/devise-links/session.rb",
+     "lib/generators/devise/links/links_generator.rb",
+     "lib/generators/devise/links/templates/devise_links.en.yml",
+     "log/development.log",
+     "spec/devise-links/generators/links_generator_spec.rb",
      "spec/devise-links/rails/configure_spec.rb",
+     "spec/devise-links/registration-links_spec.rb",
+     "spec/devise-links/session_links_spec.rb",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/kristianmandrup/devise-links}
@@ -41,9 +47,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Link helpers for Devise actions}
   s.test_files = [
-    "spec/devise-links/helpers/registration-links_spec.rb",
-     "spec/devise-links/helpers/session_links_spec.rb",
+    "spec/devise-links/generators/links_generator_spec.rb",
      "spec/devise-links/rails/configure_spec.rb",
+     "spec/devise-links/registration-links_spec.rb",
+     "spec/devise-links/session_links_spec.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -52,27 +59,39 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 2.0.0.rc"])
-      s.add_development_dependency(%q<rspec-action_view>, ["~> 0.3.1"])
-      s.add_runtime_dependency(%q<devise>, [">= 1.1.2"])
+      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<devise>, [">= 1.2"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
       s.add_runtime_dependency(%q<require_all>, ["~> 1.2.0"])
-      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.2.10"])
-      s.add_runtime_dependency(%q<r3_plugin_toolbox>, ["~> 0.3.6"])
+      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<rails3_artifactor>, [">= 0.3.1"])
+      s.add_runtime_dependency(%q<logging_assist>, ["~> 0.1.6"])
     else
-      s.add_dependency(%q<rspec>, [">= 2.0.0.rc"])
-      s.add_dependency(%q<rspec-action_view>, ["~> 0.3.1"])
-      s.add_dependency(%q<devise>, [">= 1.1.2"])
+      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<devise>, [">= 1.2"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
       s.add_dependency(%q<require_all>, ["~> 1.2.0"])
-      s.add_dependency(%q<sugar-high>, ["~> 0.2.10"])
-      s.add_dependency(%q<r3_plugin_toolbox>, ["~> 0.3.6"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
+      s.add_dependency(%q<r3_plugin_toolbox>, [">= 0.4.0"])
+      s.add_dependency(%q<rails3_artifactor>, [">= 0.3.1"])
+      s.add_dependency(%q<logging_assist>, ["~> 0.1.6"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 2.0.0.rc"])
-    s.add_dependency(%q<rspec-action_view>, ["~> 0.3.1"])
-    s.add_dependency(%q<devise>, [">= 1.1.2"])
+    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<devise>, [">= 1.2"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
     s.add_dependency(%q<require_all>, ["~> 1.2.0"])
-    s.add_dependency(%q<sugar-high>, ["~> 0.2.10"])
-    s.add_dependency(%q<r3_plugin_toolbox>, ["~> 0.3.6"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
+    s.add_dependency(%q<r3_plugin_toolbox>, [">= 0.4.0"])
+    s.add_dependency(%q<rails3_artifactor>, [">= 0.3.1"])
+    s.add_dependency(%q<logging_assist>, ["~> 0.1.6"])
   end
 end
 

data/lib/devise-links.rb

@@ -2,6 +2,10 @@ require 'require_all'
 require 'sugar-high/module'
 require 'sugar-high/alias'
 require 'devise-links/namespaces'
-require_all File.dirname(__FILE__) + '/devise-links/link'
-require_all File.dirname(__FILE__) + '/devise-links/rails'
+require 'devise-links/registration'
+require 'devise-links/session'
+
+if defined? Rails
+  require 'devise-links/rails/configure'
+end
 

data/lib/devise-links/labels.rb

@@ -0,0 +1,52 @@
+module Devise::Links
+  class << self
+    def labels
+      @lbs ||= translate_labels? ? translate_labels : default_labels
+    end
+
+    attr_accessor :translate
+
+    def translate_labels?
+      translate
+    end
+
+    def auth_labels
+      %w{sign_in sign_out sign_up edit_registration}
+    end
+
+    protected
+
+    def default_labels
+      auth_labels.inject({}) {|result, action| 
+        result[action.to_sym] = action.to_s.humanize
+        result
+      }
+    end    
+
+    def translate_labels
+      ns_actions = 'cream.actions.auth'
+      auth_labels.inject({}) {|result, action| 
+        result[action.to_sym] = t("#{ns_actions}.#{action}").humanize
+        result
+      }
+    end
+  end
+  
+  module Labels
+    # create method :new_label, :index_label and so on ...
+    Devise::Links.auth_labels.each do |name|
+      class_eval %{
+        def #{name}_label      
+          get_label :#{name}
+        end
+      }
+    end
+
+    alias_method :new_registration_label, :sign_up_label
+
+    # how to retrieve label in single location!
+    def get_label key
+      Devise::Links.labels[key]
+    end
+  end
+end

data/lib/devise-links/rails/configure.rb

@@ -3,7 +3,7 @@ require 'r3_plugin_toolbox'
 
 Rails3::Plugin::Extender.new do
   extend_rails :view do
-    extend_from_module Devise::Link, :registration, :session
+    extend_from_module Devise::Links, :registration, :session, :labels
   end        
 end
 

data/lib/devise-links/{link/registration.rb → registration.rb}

@@ -1,6 +1,7 @@
-module Devise::Link
-  module Registration  
-    
+require 'devise-links/labels'
+
+module Devise::Links
+  module Registration    
     REGISTRATION_LINKS = {
       :new_registration => :sign_up,
       :edit_registration => :edit_profile
@@ -12,8 +13,8 @@ module Devise::Link
     REGISTRATION_LINKS.keys.each do |name|
       class_eval %{
         def #{name}_link(options = {})          
-          label = options[:label] || auth_labels[:#{name}]
-          path = #{name}_path options[:role]
+          label = options[:label] || #{name}_label
+          path = #{name}_path options[:role] 
           link_to(label, path)
         end          
       }

data/lib/devise-links/{link/session.rb → session.rb}

@@ -1,4 +1,6 @@
-module Devise::Link
+require 'devise-links/labels'
+
+module Devise::Links
   module Session            
     SESSION_LINKS = {
       :sign_out => :log_out,
@@ -11,7 +13,7 @@ module Devise::Link
     SESSION_LINKS.keys.each_with_index do |name, index|
       class_eval %{
         def #{name}_link(options = {})
-          label = options[:label] || auth_labels[:#{name}]
+          label = options[:label] || #{name}_label
           path = #{ACTIONS[index]}_session_path options[:role]
           link_to(label, path)
         end          

data/lib/generators/devise/links/links_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/base'
+require 'sugar-high/array'
+require 'active_support/inflector'
+require 'rails3_artifactor'
+require 'logging_assist'
+
+module Devise
+  module Generators
+    class LinksGenerator < Rails::Generators::Base
+      desc "Configures Rails app for use with Devise Links"
+
+      source_root File.dirname(__FILE__) + '/templates'
+
+      def main_flow      
+        copy_locale
+      end
+  
+      protected
+
+      include Rails3::Assist::BasicLogger
+      # extend Rails3::Assist::UseMacro
+  
+      def copy_locale  
+        template "devise_links.en.yml", "config/locales/cream.en.yml"
+      end
+    end
+  end
+end

data/lib/generators/devise/links/templates/devise_links.en.yml

@@ -0,0 +1,9 @@
+en:
+  cream:
+    confirm: 'Are you sure?'
+    actions:
+      auth:
+        sign_in: "Sign in"
+        sign_out: "Sign out"
+        sign_up: "Sign up"
+        edit_registration: "Edit registration"

data/spec/devise-links/generators/links_generator_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper' 
+require 'generator-spec'
+
+require_generator :devise => :links
+
+RSpec::Generator.configure do |config|
+  config.debug = true
+  config.remove_temp_dir = true
+  config.default_rails_root(__FILE__) 
+  config.lib = File.dirname(__FILE__) + '/../lib'
+  config.logger = :stdout  # :file
+end
+
+
+describe 'Restlinks generator' do   
+  use_helpers :special, :file
+    
+  setup_generator :devise_links do
+    tests Devise::Generators::LinksGenerator
+  end
+
+  describe "Run it!" do
+    before :each do
+      @generator = with_generator do |g|    
+        g.run_generator
+      end
+    end
+
+    it "should have created a locales file for CanCan REST links" do
+      # Rails3::Assist::Files.locale_files.file_names.should include('cream.en.yml')
+      @generator.should have_locale_file 'cream.en'
+    end    
+  end
+end

data/spec/devise-links/registration-links_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'devise-links/links/registration'
+require 'devise-links/links/labels'
+
+describe Devise::Links::Registration do
+  
+  extend_view_with Devise::Links::Registration
+  extend_view_with Devise::Links::Labels
+  
+  describe '#new_registration_link' do
+    it "should create a registration link" do
+      view_engine do |e, view|
+        label = 'new registration'
+        path = 'new/reg/path'        
+
+        # view.stubs(:user_reg_path).with(:new, :admin).returns path
+        view.stubs(:new_registration_path).returns path
+        
+        output_label = view.new_registration_label
+                 
+        view.stubs(:link_to).returns output_label
+  
+        res = e.run_template do 
+          %{<%= new_registration_link(:role => :admin) %> }
+        end
+        res.should match /#{output_label}/
+      end
+    end
+  end
+end
+

data/spec/devise-links/{helpers/session_links_spec.rb → session_links_spec.rb}

@@ -1,23 +1,25 @@
 require 'spec_helper'
-require 'devise-links/link/session'
+require 'devise-links/links/session'
+require 'devise-links/links/labels'
 
-describe Devise::Link::Session do
+describe Devise::Links::Session do
 
-  extend_view_with Devise::Link::Session
+  extend_view_with Devise::Links::Session
+  extend_view_with Devise::Links::Labels
   
   describe '#sign_out_link' do
     it "should create a sign out link" do
-      with_engine do |e, view|
+      view_engine do |e, view|
         label = 'log out'
         path = 'admin/log/out'        
-        view.stubs(:auth_labels).returns(:sign_out => label)
         view.stubs(:destroy_session_path).with(:admin).returns path
-        view.stubs(:link_to).with(label, path).returns 'it works'        
+        output_label = view.sign_out_label
+        view.stubs(:link_to).returns output_label
 
         res = e.run_template do 
           %{<%= sign_out_link(:role => :admin) %> }
         end
-        res.should match /it works/                
+        res.should match /#{output_label}/                
       end                     
     end
   end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 5
-  version: 0.1.5
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-07 00:00:00 +02:00
+date: 2010-11-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,8 +29,7 @@ dependencies:
         - 2
         - 0
         - 0
-        - rc
-        version: 2.0.0.rc
+        version: 2.0.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -44,12 +43,12 @@ dependencies:
         segments: 
         - 0
         - 3
-        - 1
-        version: 0.3.1
+        - 4
+        version: 0.3.4
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: devise
+  name: generator-spec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -57,16 +56,45 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
+        - 0
+        - 7
+        - 0
+        version: 0.7.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: devise
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
         - 1
         - 2
-        version: 1.1.2
+        version: "1.2"
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: require_all
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -77,37 +105,67 @@ dependencies:
         - 0
         version: 1.2.0
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: sugar-high
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 2
-        - 10
-        version: 0.2.10
+        - 3
+        - 0
+        version: 0.3.0
   type: :runtime
-  version_requirements: *id005
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: r3_plugin_toolbox
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rails3_artifactor
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
         - 3
+        - 1
+        version: 0.3.1
+  type: :runtime
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: logging_assist
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
         - 6
-        version: 0.3.6
+        version: 0.1.6
   type: :runtime
-  version_requirements: *id006
+  version_requirements: *id010
 description: Link helpers for Devise actions, including user session and registration links.
 email: kmandrup@gmail.com
 executables: []
@@ -121,19 +179,25 @@ files:
 - .document
 - .gitignore
 - .rspec
+- Changelog.txt
 - LICENSE
 - README.markdown
 - Rakefile
 - VERSION
 - devise-links.gemspec
 - lib/devise-links.rb
-- lib/devise-links/link/registration.rb
-- lib/devise-links/link/session.rb
+- lib/devise-links/labels.rb
 - lib/devise-links/namespaces.rb
 - lib/devise-links/rails/configure.rb
-- spec/devise-links/helpers/registration-links_spec.rb
-- spec/devise-links/helpers/session_links_spec.rb
+- lib/devise-links/registration.rb
+- lib/devise-links/session.rb
+- lib/generators/devise/links/links_generator.rb
+- lib/generators/devise/links/templates/devise_links.en.yml
+- log/development.log
+- spec/devise-links/generators/links_generator_spec.rb
 - spec/devise-links/rails/configure_spec.rb
+- spec/devise-links/registration-links_spec.rb
+- spec/devise-links/session_links_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/kristianmandrup/devise-links
@@ -168,7 +232,8 @@ signing_key:
 specification_version: 3
 summary: Link helpers for Devise actions
 test_files: 
-- spec/devise-links/helpers/registration-links_spec.rb
-- spec/devise-links/helpers/session_links_spec.rb
+- spec/devise-links/generators/links_generator_spec.rb
 - spec/devise-links/rails/configure_spec.rb
+- spec/devise-links/registration-links_spec.rb
+- spec/devise-links/session_links_spec.rb
 - spec/spec_helper.rb

data/spec/devise-links/helpers/registration-links_spec.rb

@@ -1,25 +0,0 @@
-require 'spec_helper'
-require 'devise-links/link/registration'
-
-describe Devise::Link::Registration do
-  
-  extend_view_with Devise::Link::Registration
-  
-  describe '#new_registration_link' do
-    it "should create a registration link" do
-      with_engine do |e, view|
-        label = 'new registration'
-        path = 'new/reg/path'        
-        view.stubs(:auth_labels).returns(:new_registration => label)
-        view.stubs(:user_reg_path).with(:new, :admin).returns path 
-        view.stubs(:link_to).with(label, path).returns 'it works'
-
-        res = e.run_template do 
-          %{<%= new_registration_link(:role => :admin) %> }
-        end
-        res.should match /it works/  
-      end
-    end
-  end
-end
-