enja 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f36a7cf83cb08100e09ae42b5a52bdbae2f3e7d
+  data.tar.gz: bf152500009aa5a9814cf7b34f5d51ef6dd0493d
+SHA512:
+  metadata.gz: 38c765a07516f271a88ae997eb91ec99228b5a80d6cecdea3f0682470148175f2dc6518b9635d14ef1d7f680b08a5abef59134a7e99aba58ff740b59935c5e28
+  data.tar.gz: 4f0e9dd1d08d55a028e461ffcb8f6fc5c3b2be6d80c8fa4dffdf50a9d4927495d8f94f741e60acf667d07478efb5429fd3de1ec2e713df3fbd0ecf92f09b9127

data/README.md

@@ -0,0 +1,50 @@
+# Enja
+
+Easily role definition depend on `enumerize` gem for Rails.
+
+## Installation
+
+```ruby
+gem 'enja'
+```
+
+Optionally, you can run the generator, which will set up a role field with some useful defaults for you:
+
+```bash
+$ bin/rails g enja:install
+```
+
+## Usage
+
+Call `define_role_method` in your resource of user model (`User`, `AdminUser` or `Member` etc):
+
+```ruby
+class User < ApplicationRecord
+  define_role_method :role, in: [:guest, :staff, :admin], default: :guest
+end
+```
+
+Then it provides some convenient methods for implement role based system:
+
+```ruby
+user = User.new(role: :guest)
+
+# == Predicate Methods
+user.guest? # true
+user.staff? # false
+user.admin? # false
+
+# == Update Methods
+user.guest! # => :guest
+user.staff! # => :staff
+user.admin! # => :admin
+
+# == Scopes
+User.guest.all # User.where(role: :guest).all
+User.staff.all # User.where(role: :staff).all
+User.admin.all # User.where(role: :admin).all
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/enja.rb

@@ -0,0 +1,36 @@
+require "enumerize"
+
+require "enja/railtie"
+require "enja/version"
+
+module Enja
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    def define_role_field(attribute_name = :role, options = {})
+      enumerize_options = enja_default_options.merge!(options)
+
+      extend ::Enumerize
+      enumerize(attribute_name.to_sym, enumerize_options)
+      enumerize_options[:in].each do |role|
+        scope(role, -> { where(attribute_name => role) })
+        define_method(:"#{role}!") { update!(attribute_name => role ) }
+      end
+
+      validates(attribute_name, presence: true)
+    end
+
+    private
+
+    def enja_default_options
+      {
+        in:         %i(guest staff admin),
+        default:    :guest,
+        predicates: true,
+        scope:      true,
+      }
+    end
+  end
+end

data/lib/enja/railtie.rb

@@ -0,0 +1,9 @@
+module Enja
+  class Railtie < Rails::Railtie
+    initializer "enja" do
+      ActiveSupport.on_load(:active_record) do
+        include Enja
+      end
+    end
+  end
+end

data/lib/enja/version.rb

@@ -0,0 +1,3 @@
+module Enja
+  VERSION = "0.1.0".freeze
+end

data/lib/generators/enja/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Generates the necessary files to get you up and running with Enja gem
+
+Examples:
+  rails g enja:install
+
+    This will generate the core migration file, the initializer file and the 'User' model class.
+
+  rails g enja:install --model AdminUser --attribute state

data/lib/generators/enja/helper.rb

@@ -0,0 +1,61 @@
+module Enja
+  module Generators
+    module Helper
+      extend ActiveSupport::Concern
+
+      private
+
+      def model_class_name
+        options.key?(:model) ? options[:model].classify : "User"
+      end
+
+      def model_file_path
+        model_name.underscore
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{model_file_path}.rb")
+      end
+
+      def namespace
+        Rails::Generators.namespace if Rails::Generators.respond_to?(:namespace)
+      end
+
+      def namespaced?
+        !!namespace
+      end
+
+      def model_name
+        if namespaced?
+          [namespace.to_s] + [model_class_name]
+        else
+          [model_class_name]
+        end.join("::")
+      end
+
+      def attribute_name
+        options.key?(:attribute) ? options[:attribute].underscore : "role"
+      end
+
+      def migration_class_name
+        if Rails::VERSION::MAJOR >= 5
+          "ActiveRecord::Migration[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        else
+          "ActiveRecord::Migration"
+        end
+      end
+
+      class_methods do
+        # Define the next_migration_number method (necessary for the migration_template method to work)
+        def next_migration_number(dirname)
+          if ActiveRecord::Base.timestamped_migrations
+            sleep 1 # make sure each time we get a different timestamp
+            Time.new.utc.strftime("%Y%m%d%H%M%S")
+          else
+            format("%.3d", (current_migration_number(dirname) + 1))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/enja/install_generator.rb

@@ -0,0 +1,39 @@
+require "rails/generators/migration"
+require "generators/enja/helper"
+
+module Enja
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      include Enja::Generators::Helper
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      class_option :model, optional: true,
+                           type:     :string,
+                           banner:   "model",
+                           desc:     "Specify the model class name if you will use anything other than `User`",
+                           default:  "User"
+
+      class_option :attribute, optional: true,
+                               type:     :string,
+                               banner:   "attribute",
+                               desc:     "Specify the attribute name if you will use anything other than `role`",
+                               default:  "role"
+
+      def prepare_resource_model
+        generate "model", "#{model_class_name}" unless model_class_name.safe_constantize
+      end
+
+      def prepare_migration
+        migration_template "migration.erb", "db/migrate/add_role_to_user_resources.rb", migration_class_name: migration_class_name
+      end
+
+      def inject_resource_model
+        inject_into_file model_path, after: "class #{model_class_name} < ApplicationRecord\n" do
+          "  define_role_field :#{attribute_name}, in: [:guest, :staff, :admin], default: :guest\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/enja/templates/migration.erb

@@ -0,0 +1,6 @@
+class AddRoleToUserResources < <%= migration_class_name %>
+  def change
+    add_column :<%= model_class_name.tableize.tr('/', '_') %>, :<%= attribute_name %>, :string, null: false, default: ""
+    add_index :<%= model_class_name.tableize.tr('/', '_') %>, :<%= attribute_name %>
+  end
+end

data/spec/enja_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+RSpec.describe Enja do
+  it "has a version number" do
+    expect(Enja::VERSION).not_to be nil
+  end
+end

data/spec/model_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+RSpec.describe User, type: :model do
+  let!(:guest) { described_class.create(role: :guest) }
+  let!(:staff) { described_class.create(role: :staff) }
+  let!(:admin) { described_class.create(role: :admin) }
+
+  context 'enumerize' do
+    subject { described_class.role }
+    it { is_expected.to be_a(Enumerize::Attribute) }
+  end
+
+  context 'scope' do
+    describe '.guest' do
+      subject { described_class.guest }
+      it { is_expected.to     include guest }
+      it { is_expected.not_to include staff }
+      it { is_expected.not_to include admin }
+    end
+
+    describe '.staff' do
+      subject { described_class.staff }
+      it { is_expected.to     include staff }
+      it { is_expected.not_to include guest }
+      it { is_expected.not_to include admin }
+    end
+
+    describe '.admin' do
+      subject { described_class.admin }
+      it { is_expected.to     include admin }
+      it { is_expected.not_to include guest }
+      it { is_expected.not_to include staff }
+    end
+  end
+
+  context 'validation' do
+    it { is_expected.to validate_presence_of(:role) }
+  end
+
+  describe '#guest!' do
+    let(:instance) { described_class.create(role: :admin) }
+
+    subject(:execution) { instance.guest! }
+
+    it { is_expected.to eq true }
+    it { expect { execution }.to change { instance.role }.from('admin').to('guest') }
+  end
+
+  describe '#staff!' do
+    let(:instance) { described_class.create(role: :admin) }
+
+    subject(:execution) { instance.staff! }
+
+    it { is_expected.to eq true }
+    it { expect { execution }.to change { instance.role }.from('admin').to('staff') }
+  end
+
+  describe '#admin!' do
+    let(:instance) { described_class.create(role: :guest) }
+
+    subject(:execution) { instance.admin! }
+
+    it { is_expected.to eq true }
+    it { expect { execution }.to change { instance.role }.from('guest').to('admin') }
+  end
+end

data/spec/rails/rails-5.1.2/README.md

@@ -0,0 +1,24 @@
+# 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
+
+* ...

data/spec/rails/rails-5.1.2/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_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/rails/rails-5.1.2/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/rails/rails-5.1.2/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// 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, or any plugin's
+// vendor/assets/javascripts directory 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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require turbolinks
+//= require_tree .

data/spec/rails/rails-5.1.2/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/rails/rails-5.1.2/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, or any plugin's
+ * vendor/assets/stylesheets directory 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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/rails/rails-5.1.2/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/rails/rails-5.1.2/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/rails/rails-5.1.2/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/rails/rails-5.1.2/app/helpers/application_helper.rb

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

data/spec/rails/rails-5.1.2/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/rails/rails-5.1.2/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/rails/rails-5.1.2/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/rails/rails-5.1.2/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ApplicationRecord
+  define_role_field :role, in: [:guest, :staff, :admin], default: :guest
+end

data/spec/rails/rails-5.1.2/app/views/layouts/application.html.erb

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