royce 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a847160faf0f38db5c3abe9abfea5bcfc8550556
+  data.tar.gz: b3cb951adb5cbff81c84267a32c8f2b0d0c0a28a
+SHA512:
+  metadata.gz: 282803360fe2bdb5c2947f72a62ce3ab1ed2f4b4402416a13d9ebeb2836fb6b71f320e5642d58ceb574fbe8cd99e350eb1cc8d7e86a279201042f25183d670af
+  data.tar.gz: 35b5d32377e30ddf053a1f939242635d71d5991b05b6832887b36b6878d8e4ffa48936ec63bb98c359698293b77b27d601e049a97d2bbaf023e9998412d3184f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Martin Nash
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Royce'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/royce/install_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Royce
+  class InstallGenerator < ::Rails::Generators::Base
+
+    include ::Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'Generates DB migration files for Royce'
+    def create_migration_file
+      migration_template 'create_royce.rb', 'db/migrate/create_royce.rb'
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+  end
+end

data/lib/generators/royce/templates/create_royce.rb

@@ -0,0 +1,22 @@
+class CreateRoyce < ActiveRecord::Migration
+
+  def change
+
+    create_table :royce_connector do |t|
+      t.references :roleable, polymorphic: true, null: false
+      t.references :role, null: false
+    end
+
+    add_index :royce_connector, [:roleable_id, :roleable_type]
+    add_index :royce_connector, :role_id
+
+    create_table :royce_role do |t|
+      t.string :type
+      t.string :name, null: false
+      t.timestamps
+    end
+
+    add_index :royce_role, :name
+
+  end
+end

data/lib/royce.rb

@@ -0,0 +1,7 @@
+require 'royce/macros'
+require 'royce/methods'
+require 'royce/class_methods'
+require 'royce/role'
+require 'royce/connector'
+
+# # Nothing to see here, just requiring necessary files

data/lib/royce/class_methods.rb

@@ -0,0 +1,32 @@
+module Royce
+  module ClassMethods
+    def self.included includer
+      includer.class_eval do
+
+        # Work on class
+
+        has_many :role_connectors, as: :roleable, class_name: 'Royce::Connector'
+        has_many :roles, through: :role_connectors, class_name: 'Royce::Role'
+
+        def self.available_roles
+          self.available_role_names.map{ |name| Role.find_by(name: name) }
+        end
+
+
+        # User.admins
+        # User.editors
+        available_role_names.each do |role_name|
+          includer_class_name = includer.model_name.to_s.underscore.pluralize
+          scope role_name.pluralize, -> { Role.find_by(name: role_name).send includer_class_name.to_sym }
+        end
+
+      end
+
+      # Be able to search Role.users
+      Royce::Role.class_eval do
+        has_many includer.model_name.to_s.underscore.pluralize.to_sym, through: :connectors, source: :roleable, source_type: includer.model_name.to_s
+      end
+
+    end
+  end
+end

data/lib/royce/connector.rb

@@ -0,0 +1,9 @@
+module Royce
+
+  # Connects many roleables and roles
+  class Connector < ::ActiveRecord::Base
+    self.table_name = 'royce_connector'
+    belongs_to :roleable, polymorphic: true
+    belongs_to :role, class_name: 'Royce::Role'
+  end
+end

data/lib/royce/macros.rb

@@ -0,0 +1,39 @@
+module Royce
+  module Macros
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # How a class opts in to roller
+      # Pass an array of roles
+      def royce_roles(roles)
+        confirm_roles_exist roles
+
+        # Work in singleton class
+        # Add a read-only class variable to all who call.
+        class << self
+          attr_reader :available_role_names
+        end
+        @available_role_names = roles
+
+        include Royce::ClassMethods
+        include Royce::Methods
+      end
+
+
+      private
+
+      # Create Role objects as necessary
+      def confirm_roles_exist(role_names)
+        role_names.each do |name|
+          Role.find_or_create_by(name: name)
+        end
+      end
+    end
+  end
+
+
+  # Every ActiveRecord::Base now includes Royce::Macros
+  ActiveRecord::Base.send :include, Royce::Macros
+
+end

data/lib/royce/methods.rb

@@ -0,0 +1,39 @@
+module Royce
+  module Methods
+
+    def self.included includer
+
+
+      includer.instance_eval do
+        # Add instance methods like user? admin?
+        available_role_names.each do |name|
+          define_method("#{name}?") do
+            has_role? name
+          end
+        end
+
+      end
+    end
+
+    def add_role name
+      if allowed_role? name
+        role = Role.find_by(name: name.to_s)
+        roles << role
+      end
+    end
+
+    def remove_role name
+      role = Role.find_by(name: name.to_s)
+      roles.delete role
+    end
+
+    def has_role? name
+      roles.map(&:name).include?(name.to_s)
+    end
+
+    def allowed_role? name
+      self.class.available_role_names.include? name.to_s
+    end
+
+  end
+end

data/lib/royce/role.rb

@@ -0,0 +1,15 @@
+module Royce
+
+  # The actual data model
+  class Role < ::ActiveRecord::Base
+    self.table_name = 'royce_role'
+
+    has_many :connectors, class_name: 'Royce::Connector'
+
+    def to_s
+      name
+    end
+
+  end
+
+end

data/lib/royce/version.rb

@@ -0,0 +1,3 @@
+module Royce
+  VERSION = "1.0.1"
+end

data/lib/tasks/royce_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  royce_roles %w[ user admin editor ]
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "royce"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3