rolify 3.3.0.rc2 → 3.3.0.rc3

data/Rakefile

@@ -5,5 +5,17 @@ task :default => :spec
 
 desc "Run all specs"
 task "spec" do
-  exec "bundle exec rspec spec"
+  Rake::Task['generators'].invoke
+  return_code1 = $?.exitstatus
+  Rake::Task['rolify'].invoke
+  return_code2 = $?.exitstatus
+  fail if return_code1 != 0 || return_code2 != 0
+end
+
+task "generators" do
+  system "bundle exec rspec spec/generators"
+end
+
+task "rolify" do
+  system "bundle exec rspec spec/rolify"
 end

data/lib/generators/active_record/rolify_generator.rb

@@ -0,0 +1,50 @@
+require 'rails/generators/active_record'
+require 'active_support/core_ext'
+
+module ActiveRecord
+  module Generators
+    class RolifyGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      
+      argument :user_cname, :type => :string, :default => "User", :banner => "User"
+      
+      def generate_model
+        invoke "active_record:model", [ name ], :migration => false
+      end
+      
+      def inject_role_class
+        inject_into_class(model_path, class_name, model_content)
+      end
+      
+      def copy_rolify_migration
+        migration_template "migration.rb", "db/migrate/rolify_create_#{table_name}"
+      end
+      
+      def join_table
+        user_cname.constantize.table_name + "_" + table_name
+      end
+      
+      def user_reference
+        user_cname.demodulize.underscore
+      end
+      
+      def role_reference
+        class_name.demodulize.underscore
+      end
+      
+      def model_path
+        File.join("app", "models", "#{file_path}.rb")
+      end
+      
+      def model_content
+        content = <<RUBY
+  has_and_belongs_to_many :%{user_cname}, :join_table => :%{join_table}
+  belongs_to :resource, :polymorphic => true
+  
+  scopify
+RUBY
+        content % { :user_cname => user_cname.constantize.table_name, :join_table => "#{user_cname.constantize.table_name}_#{table_name}"}
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,19 @@
+class RolifyCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+      t.string :name
+      t.references :resource, :polymorphic => true
+
+      t.timestamps
+    end
+
+    create_table(:<%= join_table %>, :id => false) do |t|
+      t.references :<%= user_reference %>
+      t.references :<%= role_reference %>
+    end
+
+    add_index(:<%= table_name %>, :name)
+    add_index(:<%= table_name %>, [ :name, :resource_type, :resource_id ])
+    add_index(:<%= join_table %>, [ :<%= user_reference %>_id, :<%= role_reference %>_id ])
+  end
+end

data/lib/generators/mongoid/rolify_generator.rb

@@ -0,0 +1,51 @@
+require 'rails/generators/mongoid_generator'
+require 'active_support/core_ext'
+
+module Mongoid
+  module Generators
+    class RolifyGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      
+      argument :user_cname, :type => :string, :default => "User", :banner => "User"
+      
+      def generate_model
+        invoke "mongoid:model", [ name ]
+      end
+      
+      def inject_role_class
+        inject_into_file(model_path, model_contents, :after => "include Mongoid::Document\n")
+      end
+      
+      def user_reference
+        user_cname.demodulize.underscore
+      end
+      
+      def role_reference
+        class_name.demodulize.underscore
+      end
+      
+      def model_path
+        File.join("app", "models", "#{file_path}.rb")
+      end
+      
+      def model_contents
+        content = <<RUBY
+  has_and_belongs_to_many :%{user_cname}
+  belongs_to :resource, :polymorphic => true
+  
+  field :name, :type => String
+
+  index({
+    :name => 1,
+    :resource_type => 1,
+    :resource_id => 1
+  },
+  { :unique => true})
+  
+  scopify
+RUBY
+        content % { :user_cname => user_cname.constantize.table_name }
+      end
+    end
+  end
+end

data/lib/generators/rolify/rolify_generator.rb

@@ -0,0 +1,35 @@
+module Rolify
+  module Generators
+    class RolifyGenerator < Rails::Generators::NamedBase
+      Rails::Generators::ResourceHelpers
+      
+      source_root File.expand_path('../templates', __FILE__)
+      argument :user_cname, :type => :string, :default => "User"
+
+      namespace :rolify
+      hook_for :orm, :required => true
+
+      desc "Generates a model with the given NAME and a migration file."
+
+      def self.start(args, config)
+        user_cname = args.size > 1 ? args[1] : "User"
+        args.insert(1, user_cname) # 0 being the view name
+        super
+      end
+      
+      def inject_user_class
+        invoke "rolify:user", [ user_cname, class_name ], :orm => options.orm
+      end
+        
+      def copy_initializer_file
+        template "initializer.rb", "config/initializers/rolify.rb"
+      end
+      
+      def show_readme
+        if behavior == :invoke
+          readme "README"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rolify/{role/templates → templates}/initializer.rb

@@ -1,6 +1,6 @@
-Rolify.configure<%= "(\"#{role_cname.camelize.to_s}\")" if role_cname != "Role" %> do |config|
+Rolify.configure<%= "(\"#{class_name.camelize.to_s}\")" if class_name != "Role" %> do |config|
   # By default ORM adapter is ActiveRecord. uncomment to use mongoid
-  <%= "# " if orm_adapter == "active_record" %>config.use_mongoid
+  <%= "# " if options.orm == :active_record || !options.orm %>config.use_mongoid
   
   # Dynamic shortcuts for User class (user.is_admin? like methods). Default is: false
   # Enable this feature _after_ running rake db:migrate as it relies on the roles table

data/lib/generators/rolify/templates/role-active_record.rb

@@ -0,0 +1,11 @@
+class <%= role_cname.camelize %> < ActiveRecord::Base
+<% if need_table_prefix?(role_cname) %>
+  def self.table_name_prefix
+    <%= table_prefix(role_cname) %>_
+  end
+<% end %>
+  has_and_belongs_to_many :<%= user_cname.tableize %>, :join_table => :<%= "#{table_name(user_cname, true)}_#{table_name(role_cname, true)}" %>
+  belongs_to :resource, :polymorphic => true
+  
+  scopify
+end

data/lib/generators/rolify/user_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators/migration'
+require 'active_support/core_ext'
+
+module Rolify
+  module Generators
+    class UserGenerator < Rails::Generators::NamedBase
+      argument :role_cname, :type => :string, :default => "Role"
+      class_option :orm, :type => :string, :default => "active_record"
+      
+      desc "Inject rolify method in the User class."
+
+      def inject_user_content
+        inject_into_file(model_path, :after => inject_rolify_method) do
+          "  rolify#{role_association}\n"
+        end
+      end
+      
+      def inject_rolify_method
+        if options.orm == :active_record
+          /class #{class_name.camelize}\n|class #{class_name.camelize} .*\n|class #{class_name.demodulize.camelize}\n|class #{class_name.demodulize.camelize} .*\n/
+        else
+          /include Mongoid::Document\n|include Mongoid::Document .*\n/
+        end
+      end
+      
+      def model_path
+        File.join("app", "models", "#{file_path}.rb")
+      end
+      
+      def role_association
+        if role_cname != "Role"
+          " :role_cname => '#{role_cname.camelize}'"
+        else
+          ""
+        end
+      end
+    end
+  end
+end

data/lib/rolify/version.rb

@@ -1,3 +1,3 @@
 module Rolify
-  VERSION = "3.3.0.rc2"
+  VERSION = "3.3.0.rc3"
 end

data/spec/generators/rolify/{role/role_generator_spec.rb → rolify_generator_spec.rb}

@@ -1,11 +1,11 @@
-require 'spec_helper'
+require 'generators_helper'
 
 # Generators are not automatically loaded by Rails
-require 'generators/rolify/role/role_generator'
+require 'generators/rolify/rolify_generator'
 
-describe Rolify::Generators::RoleGenerator do
+describe Rolify::Generators::RolifyGenerator do
   # Tell the generator where to put its output (what it thinks of as Rails.root)
-  destination File.expand_path("../../../../../tmp", __FILE__)
+  destination File.expand_path("../../../../tmp", __FILE__)
   teardown :cleanup_destination_root
   
   before { 
@@ -16,15 +16,19 @@ describe Rolify::Generators::RoleGenerator do
     FileUtils.rm_rf destination_root
   end
 
-  describe 'no arguments' do
-    before(:all) { arguments [] }
+  describe 'specifying only Role class name' do
+    before(:all) { arguments %w(Role) }
 
     before { 
       capture(:stdout) {
         generator.create_file "app/models/user.rb" do
-          "class User < ActiveRecord::Base\nend"
+<<-RUBY
+  class User < ActiveRecord::Base
+  end
+RUBY
         end
       }
+      require File.join(destination_root, "app/models/user.rb")
       run_generator 
     }
     
@@ -58,7 +62,7 @@ describe Rolify::Generators::RoleGenerator do
     end
   end
 
-  describe 'specifying user and role names' do
+  describe 'specifying User and Role class names' do
     before(:all) { arguments %w(AdminRole AdminUser) }
     
     before { 
@@ -67,6 +71,7 @@ describe Rolify::Generators::RoleGenerator do
           "class AdminUser < ActiveRecord::Base\nend"
         end
       }
+      require File.join(destination_root, "app/models/admin_user.rb")
       run_generator
     }
     
@@ -79,7 +84,7 @@ describe Rolify::Generators::RoleGenerator do
       it { should contain "# config.use_mongoid" }
     end
     
-    describe 'app/models/rank.rb' do
+    describe 'app/models/admin_role.rb' do
       subject { file('app/models/admin_role.rb') }
       
       it { should exist }
@@ -103,21 +108,74 @@ describe Rolify::Generators::RoleGenerator do
     end
   end
   
-  describe 'specifying orm adapter' do 
-    before(:all) { arguments [ "Role", "User", "mongoid" ] }
+  describe 'specifying namespaced User and Role class names' do
+    before(:all) { arguments %w(Admin::Role Admin::User) }
+    
+    before { 
+      capture(:stdout) {
+        generator.create_file "app/models/admin/user.rb" do
+<<-RUBY
+module Admin
+  class User < ActiveRecord::Base
+    self.table_name_prefix = 'admin_'
+  end
+end
+RUBY
+        end
+      }
+      require File.join(destination_root, "app/models/admin/user.rb")
+      run_generator
+    }
+    
+    describe 'config/initializers/rolify.rb' do
+      subject { file('config/initializers/rolify.rb') }
+      
+      it { should exist }
+      it { should contain "Rolify.configure(\"Admin::Role\") do |config|"}
+      it { should contain "# config.use_dynamic_shortcuts" }
+      it { should contain "# config.use_mongoid" }
+    end
+    
+    describe 'app/models/admin/role.rb' do
+      subject { file('app/models/admin/role.rb') }
+      
+      it { should exist }
+      it { should contain "class Admin::Role < ActiveRecord::Base" }
+      it { should contain "has_and_belongs_to_many :admin_users, :join_table => :admin_users_admin_roles" }
+      it { should contain "belongs_to :resource, :polymorphic => true" }
+    end
+    
+    describe 'app/models/admin/user.rb' do
+      subject { file('app/models/admin/user.rb') }
+      
+      it { should contain /class User < ActiveRecord::Base\n  rolify :role_cname => 'Admin::Role'\n/ }
+    end
+    
+    describe 'migration file' do
+      subject { migration_file('db/migrate/rolify_create_admin_roles.rb') }
+      
+      it { should be_a_migration }
+      it { should contain "create_table(:admin_roles)" }
+      it { should contain "create_table(:admin_users_admin_roles, :id => false) do" }
+    end
+  end
+  
+  describe 'specifying ORM adapter' do 
+    before(:all) { arguments [ "Role", "User", "--orm=mongoid" ] }
     
     before { 
       capture(:stdout) {
         generator.create_file "app/models/user.rb" do
-<<-CLASS 
+<<-RUBY
 class User
   include Mongoid::Document
 
   field :login, :type => String
 end
-CLASS
+RUBY
         end
       }
+      require File.join(destination_root, "app/models/user.rb")
       run_generator
     }
       
@@ -149,4 +207,48 @@ CLASS
       it { should contain /class User\n  include Mongoid::Document\n  rolify\n/ }
     end
   end
+  
+  describe 'specifying namespaced User and Role class names and ORM adapter' do
+    before(:all) { arguments %w(Admin::Role Admin::User --orm=mongoid) }
+    
+    before { 
+      capture(:stdout) {
+        generator.create_file "app/models/admin/user.rb" do
+<<-RUBY
+module Admin
+  class User
+    include Mongoid::Document
+  end
+end
+RUBY
+        end
+      }
+      require File.join(destination_root, "app/models/admin/user.rb")
+      run_generator
+    }
+    
+    describe 'config/initializers/rolify.rb' do
+      subject { file('config/initializers/rolify.rb') }
+      
+      it { should exist }
+      it { should contain "Rolify.configure(\"Admin::Role\") do |config|"}
+      it { should contain "# config.use_dynamic_shortcuts" }
+      it { should_not contain "# config.use_mongoid" }
+    end
+    
+    describe 'app/models/admin/role.rb' do
+      subject { file('app/models/admin/role.rb') }
+      
+      it { should exist }
+      it { should contain "class Admin::Role" }
+      it { should contain "has_and_belongs_to_many :admin_users" }
+      it { should contain "belongs_to :resource, :polymorphic => true" }
+    end
+    
+    describe 'app/models/admin/user.rb' do
+      subject { file('app/models/admin/user.rb') }
+      
+      it { should contain /class User\n    include Mongoid::Document\n  rolify :role_cname => 'Admin::Role'\n/ }
+    end
+  end
 end

data/spec/generators_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require "bundler/setup"
+
+require 'rolify'
+require 'rolify/matchers'
+require 'rails/all'
+
+module TestApp
+  class Application < ::Rails::Application
+    config.root = File.dirname(__FILE__)
+  end
+end
+
+require 'ammeter/init'

data/spec/rolify/shared_examples/shared_examples_for_scopes.rb

@@ -1,7 +1,7 @@
 require "rolify/shared_contexts"
 
 shared_examples_for "Role.scopes" do |param_name, param_method|
-  before(:all) do
+  before(:each) do
     role_class.destroy_all
   end
   
@@ -28,7 +28,7 @@ shared_examples_for "Role.scopes" do |param_name, param_method|
     let!(:zombie_role) { subject.add_role :visitor, Forum.last }
     let!(:anonymous_role) { subject.add_role :anonymous, Group.last }
     
-    it { subject.roles.instance_scoped.should == [ visitor_role, zombie_role, anonymous_role ] }
+    it { subject.roles.instance_scoped.all.entries.should == [ visitor_role, zombie_role, anonymous_role ] }
     it { subject.roles.instance_scoped(Forum).should == [ visitor_role, zombie_role ] }
     it { subject.roles.instance_scoped(Forum.first).should == [ visitor_role ] }
     it { subject.roles.instance_scoped(Forum.last).should == [ zombie_role ] }

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require "bundler/setup"
 
 require 'rolify'
 require 'rolify/matchers'
-require 'ammeter/init'
+require 'rails/all'
 
 ENV['ADAPTER'] ||= 'active_record'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolify
 version: !ruby/object:Gem::Version
-  version: 3.3.0.rc2
+  version: 3.3.0.rc3
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-08 00:00:00.000000000 Z
+date: 2013-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -204,14 +204,17 @@ files:
 - README.md
 - Rakefile
 - UPGRADE.rdoc
-- lib/generators/rolify/role/role_generator.rb
-- lib/generators/rolify/role/templates/README
-- lib/generators/rolify/role/templates/README-active_record
-- lib/generators/rolify/role/templates/README-mongoid
-- lib/generators/rolify/role/templates/initializer.rb
-- lib/generators/rolify/role/templates/migration.rb
-- lib/generators/rolify/role/templates/role-active_record.rb
-- lib/generators/rolify/role/templates/role-mongoid.rb
+- lib/generators/active_record/rolify_generator.rb
+- lib/generators/active_record/templates/README
+- lib/generators/active_record/templates/migration.rb
+- lib/generators/mongoid/rolify_generator.rb
+- lib/generators/mongoid/templates/README-mongoid
+- lib/generators/rolify/rolify_generator.rb
+- lib/generators/rolify/templates/README
+- lib/generators/rolify/templates/initializer.rb
+- lib/generators/rolify/templates/role-active_record.rb
+- lib/generators/rolify/templates/role-mongoid.rb
+- lib/generators/rolify/user_generator.rb
 - lib/rolify.rb
 - lib/rolify/adapters/active_record/resource_adapter.rb
 - lib/rolify/adapters/active_record/role_adapter.rb
@@ -230,7 +233,8 @@ files:
 - lib/rolify/utils.rb
 - lib/rolify/version.rb
 - rolify.gemspec
-- spec/generators/rolify/role/role_generator_spec.rb
+- spec/generators/rolify/rolify_generator_spec.rb
+- spec/generators_helper.rb
 - spec/rolify/config_spec.rb
 - spec/rolify/custom_spec.rb
 - spec/rolify/matchers_spec.rb
@@ -276,12 +280,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: rolify
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Roles library with resource scoping
 test_files:
-- spec/generators/rolify/role/role_generator_spec.rb
+- spec/generators/rolify/rolify_generator_spec.rb
+- spec/generators_helper.rb
 - spec/rolify/config_spec.rb
 - spec/rolify/custom_spec.rb
 - spec/rolify/matchers_spec.rb

data/lib/generators/rolify/role/role_generator.rb

@@ -1,52 +0,0 @@
-require 'rails/generators/migration'
-
-module Rolify
-  module Generators
-    class RoleGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-
-      source_root File.expand_path('../templates', __FILE__)
-      argument :role_cname, :type => :string, :default => "Role"
-      argument :user_cname, :type => :string, :default => "User"
-      argument :orm_adapter, :type => :string, :default => "active_record"
-      #class_option :dynamic_shortcuts, :type => :boolean, :default => false
-
-      desc "Generates a model with the given NAME and a migration file."
-
-      def generate_role
-        template "role-#{orm_adapter}.rb", "app/models/#{role_cname.underscore}.rb"
-        inject_into_file(model_path, :after => inject_rolify_method) do
-          "  rolify" + (role_cname == "Role" ? "" : " :role_cname => '#{role_cname.camelize}'") + "\n"
-        end
-      end
-
-      def copy_role_file
-        template "initializer.rb", "config/initializers/rolify.rb"
-        migration_template "migration.rb", "db/migrate/rolify_create_#{role_cname.tableize}" if orm_adapter == "active_record"
-      end
-
-      def model_path
-        File.join("app", "models", "#{user_cname.underscore}.rb")
-      end
-      
-      def self.next_migration_number(path)
-        Time.now.utc.strftime("%Y%m%d%H%M%S")
-      end
-      
-      def show_readme
-        if behavior == :invoke
-          readme "README"
-          readme "README-#{orm_adapter}"
-        end
-      end
-      
-      def inject_rolify_method
-        if orm_adapter == "active_record"
-          /class #{user_cname.camelize}\n|class #{user_cname.camelize} .*\n/
-        else
-          /include Mongoid::Document\n|include Mongoid::Document .*\n/
-        end
-      end
-    end
-  end
-end

data/lib/generators/rolify/role/templates/migration.rb

@@ -1,19 +0,0 @@
-class RolifyCreate<%= role_cname.pluralize.camelize %> < ActiveRecord::Migration
-  def change
-    create_table(:<%= role_cname.tableize %>) do |t|
-      t.string :name
-      t.references :resource, :polymorphic => true
-
-      t.timestamps
-    end
-
-    create_table(:<%= (user_cname.tableize + "_" + role_cname.tableize) %>, :id => false) do |t|
-      t.references :<%= user_cname.underscore.singularize %>
-      t.references :<%= role_cname.underscore.singularize %>
-    end
-
-    add_index(:<%= role_cname.tableize %>, :name)
-    add_index(:<%= role_cname.tableize %>, [ :name, :resource_type, :resource_id ])
-    add_index(:<%= "#{user_cname.tableize}_#{role_cname.tableize}" %>, [ :<%= user_cname.underscore.singularize %>_id, :<%= role_cname.underscore.singularize %>_id ])
-  end
-end

data/lib/generators/rolify/role/templates/role-active_record.rb

@@ -1,6 +0,0 @@
-class <%= role_cname.camelize %> < ActiveRecord::Base
-  has_and_belongs_to_many :<%= user_cname.tableize %>, :join_table => :<%= "#{user_cname.tableize}_#{role_cname.tableize}" %>
-  belongs_to :resource, :polymorphic => true
-  
-  scopify
-end