global_roles 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2VkYjFjZmU0MjAxNzc0MmJlYjJmYmJmYmQ0OThkOGRiNDZjYjFjNw==
+  data.tar.gz: !binary |-
+    N2I5ZDVmNWM1ZGI5ZTBkNmE3ODlkNDUzMjc4ZDk0ZDcxMDEyMjYxZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODJkYjNhMmU1NTM5Nzk0ZjVjNDI5NTM1MTIxMTdkZjhjM2EzNGYwYTA0ZmZh
+    YjE4ZTFiMzVhNjc0NGZkZGI4NjUwYjI1NTcxOWJlNTgwNjE3NTVhNzY1YzI0
+    OGM2ZGUzMTdmNzg0OTM2M2EyOGY3MzI2OGZhMTg2YTY4Yzk3ODk=
+  data.tar.gz: !binary |-
+    MjAyZDEwYTNkN2VlZjQzNTJkODZlMGNmOGRmMGIwNzcwNDc2ZDliYzMwMDFk
+    NTQ2NjIzNmVjOTc5OGZmOGQ3ZmI0YjEyYmI3ZTg5ZmEwZmVjNDQ1NDJkYjhk
+    NWU4ZTg1MTI5NTIwMTA1MzU0MTBkYjQzNTQzNzU4YTQyOGM3NzI=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+# GlobalRoles
+
+_**Disclaimer #1:** My english is awful, so feel free to send me 
+corrections of this text._
+
+_**Disclaimer #2:** If you like this project, please 
+[![endorse](https://api.coderwall.com/gvino/endorsecount.png)](https://coderwall.com/gvino) 
+me on coderwall._
+
+This is a simple gem to add global role to any model in your
+Ruby on Rails application.
+
+## Usage
+
+For example if you have model `User` and want to add global
+role to it, you should do following things:
+
+    $ rails generate global_roles:install User
+    $ rake db:migrate
+
+If you want to specify your own roles list, you should provide it 
+after model name, e.g.
+
+    $ rails generate global_roles:install User role1 role2
+
+If you want to specify role that will be default for model you 
+should mark it as default in roles list:
+
+    $ rails generate global_roles:install User role1 role2:default
+
+**Be careful! If you don't specify default role, it will be first 
+role in list.**
+
+After this you will see something like this in your model:
+
+```ruby
+  class User < ActiveRecord::Base
+    ROLES = [:regular, :admin, :moderator]
+    # or, if you provide roles list
+    # ROLES = [:role1, :role2, ...]
+    setup_global_roles!
+
+    <your old code here>
+  end
+```
+
+Constant `ROLES` contains list of roles that you will be able to set 
+to your model.  You can add new roles to the and of this array but 
+not between existing elements since there are any models with roles 
+in your database otherwise you won't like results.
+
+If you pass optional argument `default: <role_name>` to 
+`setup_global_roles!` it will set `<role_name>` as default global 
+role for new instances of your model.
+
+You can check model's role anywhere in your application using query 
+methods `global_<role_name>?`, for example:
+
+```ruby
+  if @user.global_admin?
+    <some actions>
+  end
+```
+
+If you want to set role to model, you can do it two ways. You may 
+pass role name
+
+```ruby
+  @user.global_role = :admin
+```
+
+or role index:
+
+```ruby
+  @user.global_role = 2 # set User::ROLES[2] role
+```
+
+If you need to collect all models with particular role, you should 
+use `Model.with_global_role` method:
+
+```ruby
+  User.with_global_role(:moderator) # will return list of moderators
+```
+
+## TODO
+
+- [x] Add validation to model
+- [x] Make `with_global_role` method a scope
+- [x] Add possibility to set default role through generator
+- [ ] **Make specs readable**
+
+## License
+
+This code is distributed under terms of MIT-LICENSE

data/Rakefile

@@ -0,0 +1,43 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rspec/core/rake_task'
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GlobalRoles'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:generators) do |task|
+  task.pattern = "spec/generators/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new(:global_roles) do |task|
+  task.pattern = "spec/global_roles/**/*_spec.rb"
+end
+
+task :default => :spec
+
+desc "Run all specs"
+task "spec" do
+  Rake::Task['generators'].invoke
+  return_code1 = $?.exitstatus
+  Rake::Task['global_roles'].invoke
+  return_code2 = $?.exitstatus
+  fail if return_code1 != 0 || return_code2 != 0
+end

data/lib/generators/active_record/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators/active_record'
+require 'active_support/core_ext'
+
+module ActiveRecord
+  module Generators
+    class InstallGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_global_roles_migration
+        migration_template "migration.rb", "db/migrate/add_global_role_to_#{table_name}"
+      end
+
+      def model_path
+        File.join("app", "models", "#{file_path}.rb")
+      end
+
+      def default_value
+        args.first == -1 ? 0 : args.first
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+class AddGlobalRoleTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    add_column :<%= table_name %>, :global_role, :integer, :null => :false, :default => <%= default_value %>
+    add_index :<%= table_name %>, :global_role
+  end
+end

data/lib/generators/global_roles/install_generator.rb

@@ -0,0 +1,63 @@
+require 'rails/generators/migration'
+require 'active_support/core_ext'
+
+module GlobalRoles
+  module Generators
+    class InstallGenerator < Rails::Generators::NamedBase
+      Rails::Generators::ResourceHelpers
+
+      DEFAULT_ROLES = %w(regular admin moderator)
+
+      source_root File.expand_path('../templates', __FILE__)
+      argument :roles, :type => :array, :default => DEFAULT_ROLES,
+                       :banner => "role1[:default] role2[:default] role3[:default] ..."
+
+      desc "Inject roles list and `set_global_roles` method in the specified class"
+
+      def inject_user_class
+        inject_into_file(model_path, :after => inject_global_roles_method) do
+<<RUBY
+
+  # Global roles
+  ROLES = #{roles_list}
+  setup_global_roles!#{default_role}
+
+RUBY
+        end
+      end
+
+      def setup_migration
+        invoke "active_record:install", [ name, fetch_default ]
+      end
+
+      protected
+
+      def inject_global_roles_method
+        Regexp.union(
+          /class #{class_name.camelize}\n/,
+          /class #{class_name.camelize} .*\n/,
+          /class #{class_name.demodulize.camelize}\n/,
+          /class #{class_name.demodulize.camelize} .*\n/
+        )
+      end
+
+      def model_path
+        File.join("app", "models", "#{file_path}.rb")
+      end
+
+      def roles_list
+        roles.map{ |r| r.split(':').first.to_sym }
+      end
+
+      def fetch_default
+        d = roles.map {|r| r.split(':') }.select {|r| r[1] == 'default'}
+        d.empty? ? -1 : roles_list.index(d[0].first.to_sym)
+      end
+
+      def default_role
+        a = fetch_default
+        (a == -1) ? '' : " default: :#{roles_list[a]}"
+      end
+    end
+  end
+end

data/lib/global_roles/methods.rb

@@ -0,0 +1,56 @@
+module GlobalRoles
+  module Methods
+    extend ::ActiveSupport::Concern
+
+    def global_role
+      @global_role ||= self.class::ROLES[self.global_role_id]
+    end
+
+    def global_role_id
+      self.read_attribute :global_role
+    end
+
+    def reload_global_role
+      @global_role = nil
+    end
+
+    def global_role=(name)
+      write_attribute(:global_role, self.class::global_role_id_for(name))
+    end
+
+    def global_role_id=(id)
+      unless id.is_a? Fixnum
+        raise ArgumentError, "Expected a Fixnum, but got \#{id.inspect}"
+      end
+      id = self.class::global_role_id_for(id)
+      @global_role = nil
+      write_attribute(:global_role, id)
+    end
+
+    module ClassMethods
+      def values_for_global_role
+        self::ROLES
+      end
+
+      def global_role_id_for(r)
+        if !valid_role?(r)
+          raise ArgumentError, "Unsupported value for `global_role': #{r.inspect}"
+        end
+        (r.is_a? Integer) ? r : self::ROLES.index(r)
+      end
+
+      private
+      def valid_role?(r)
+        if (r.is_a? Integer)
+          if !(0...self::ROLES.size).include?(r)
+            return false
+          end
+        else
+          return self::ROLES.include?(r.respond_to?(:to_sym) ? r.to_sym : r)
+        end
+        true
+      end
+    end
+
+  end
+end

data/lib/global_roles/version.rb

@@ -0,0 +1,3 @@
+module GlobalRoles
+  VERSION = "0.0.2"
+end

data/lib/global_roles.rb

@@ -0,0 +1,42 @@
+require 'active_record'
+require 'active_support'
+require 'global_roles/methods.rb'
+
+module GlobalRoles
+  extend ::ActiveSupport::Concern
+
+  module ClassMethods
+    protected
+    def setup_global_roles!(options = {})
+      self::ROLES.freeze
+      include GlobalRoles::Methods
+
+      if default = options[:default] || 0
+        after_initialize do
+          self.global_role = default unless global_role? || persisted?
+        end
+      end
+
+      self::ROLES.each do |r|
+        define_method("global_#{r}?".to_sym) do
+          global_role == r
+        end
+      end
+
+      self.class_eval %(
+        scope :with_global_role,
+          proc { |r|
+            where(:global_role => #{self}::global_role_id_for(r))
+          }
+      )
+    end
+  end
+
+  def reload(*)
+    super
+    reload_role
+    self
+  end
+end
+
+ActiveRecord::Base.send :include, GlobalRoles

data/lib/tasks/global_roles_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :global_roles do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: global_roles
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- George Vinogradov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple gem to provide global roles for ActiveRecrod models without using
+  of another models
+email:
+- g-vino@yandex.ru
+- g.vinogradov@itima.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/active_record/install_generator.rb
+- lib/generators/active_record/templates/migration.rb
+- lib/generators/global_roles/install_generator.rb
+- lib/global_roles/methods.rb
+- lib/global_roles/version.rb
+- lib/global_roles.rb
+- lib/tasks/global_roles_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/gvino/rails_global_roles
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple roles gem
+test_files: []