wildland_herd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef34cbdf688339590f67e8c818a2f6e494399d30
+  data.tar.gz: 9be562f0930080e782f452c42d4d1606c704b793
+SHA512:
+  metadata.gz: 089af9e6de8381f37d8db8620387a29f6a6cb59b6eb23106b8841aa6bba67ee3a98723301db89f3b5191271adb10dd56661e16f67b9e1eb7bb29b1311915e657
+  data.tar.gz: 56c3d75da963caf1ef6bdfd58e34e30ffc55a30855f35a7797dbd6859ba6310499ff3447efa221fc10830af4692bbe4a5e9ffde80bad686ba71c0da6a5fbfed2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Joe Weakley
+
+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,46 @@
+begin
+  require 'bundler/setup'
+  require 'bundler/gem_tasks'
+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    = 'WildlandHerd'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+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 :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'wildland_herd'
+  ARGV.clear
+  IRB.start
+end
+
+
+task default: :test

data/lib/generators/wildland_herd/base_resource_generator.rb

@@ -0,0 +1,97 @@
+require 'rails/generators/named_base'
+
+module WildlandHerd
+  module Generators
+    class BaseResourceGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+      desc "Generates a model with the given NAME (if one does not exist) plus a migration file."
+      class_option :generate_migration, type: :boolean, default: true
+      class_option :generate_active_model_serializer, type: :boolean, default: true
+      class_option :generate_pundit_policy, type: :boolean, default: true
+      class_option :generate_factory_girl_factories, type: :boolean, default: true
+      class_option :generate_api_controllers, type: :boolean, default: true
+      class_option :api_controller_version, type: :string, default: 'v1'
+
+
+      def generate_model
+        template 'model.rb', File.join('app/models', "#{singular_name}.rb")
+      end
+
+      def generate_api_controllers
+        if options.generate_api_controllers?
+          template(
+            'api_controller.rb',
+            File.join(
+              'app/controllers/api',
+              "#{options.api_controller_version}",
+              "#{plural_name}_controller.rb"
+            )
+          )
+          insert_after_version("    resources :#{plural_name}")
+        end
+      end
+
+      def generate_active_model_serializer
+        if options.generate_active_model_serializer?
+          template 'active_model_serializer.rb', File.join('app/serializers', "#{singular_name}_serializer.rb")
+        end
+      end
+
+      def generate_factory_girl_factories
+        if options.generate_factory_girl_factories?
+          template 'factory_girl_factory.rb', File.join('spec/factories', "#{plural_name}.rb")
+        end
+      end
+
+
+      def generate_pundit_policy
+        if options.generate_pundit_policy?
+          template 'pundit_policy.rb', File.join('app/policies', "#{singular_name}_policy.rb")
+        end
+      end
+
+      def generate_migration
+        if options.generate_migration?
+          migration_template "migration.rb", "db/migrate/wildland_herd_create_#{table_name}.rb"
+        end
+      end
+
+      protected
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def next_migration_number
+        self.class.next_migration_number('db/migrations')
+      end
+
+      def insert_after_version(string)
+        maybe_create_api_v1_namespace
+
+        in_root do
+          insert_into_file(
+            'config/routes.rb',
+            "#{string}\n",
+            after: "namespace :#{options.api_controller_version} do\n"
+          )
+        end
+      end
+
+      def maybe_create_api_v1_namespace
+        in_root do
+          unless File.readlines('config/routes.rb').grep('namespace :api do')
+            route <<-ROUTE
+namespace :api do
+    namespace :#{options.api_controller_version} do
+    end
+  end
+ROUTE
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/wildland_herd/install_generator.rb

@@ -0,0 +1,48 @@
+module WildlandHerd
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Creates a WildlandHerd initializer and copy locale files to your application."
+      class_option :organization_name, type: :string, default: 'organization', description: 'Name of organization class.'
+      class_option :permission_name, type: :string, default: 'permission', description: 'Name of permission class.'
+      class_option :role_name, type: :string, default: 'role', description: 'Name of role class.'
+      class_option :enable_user_management, type: :boolean, default: true
+      class_option :add_pundit_policy, type: :boolean, default: true
+      class_option :create_sample_data, type: :boolean, default: true
+
+      def add_pundit_policy
+        if options.add_pundit_policy?
+          template 'pundit_application_policy.rb', File.join('app/policies', 'application_policy.rb')
+        end
+      end
+
+      def generate_models
+        invoke(
+          'wildland_herd:organizations',
+          [options.organization_name],
+          [
+            "--role_name=#{options.role_name}",
+            "--permission_name=#{options.permission_name}"
+          ]
+        )
+        invoke(
+          'wildland_herd:roles',
+          [options.role_name],
+          [
+            "--organization_name=#{options.organization_name}",
+            "--permissions_name=#{options.permission_name}",
+            "--enable_user_management=#{options.enable_user_management}",
+          ]
+        )
+        invoke(
+          'wildland_herd:permissions',
+          [options.permission_name],
+          [
+            "--organization_name=#{options.organization_name}",
+            "--role_name=#{options.role_name}",
+          ]
+        )
+      end
+    end
+  end
+end

data/lib/generators/wildland_herd/organizations/organizations_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/wildland_herd/base_resource_generator'
+
+module WildlandHerd
+  module Generators
+    class OrganizationsGenerator < BaseResourceGenerator
+      source_root File.expand_path("../templates", __FILE__)
+      class_option :role_name, type: :string, default: ''
+      class_option :permission_name, type: :string, default: ''
+
+      protected
+
+      def attributes
+        [:name]
+      end
+    end
+  end
+end

data/lib/generators/wildland_herd/organizations/templates/active_model_serializer.rb

@@ -0,0 +1,7 @@
+class <%= class_name %>Serializer < ActiveModel::Serializer
+  embed :ids
+  attributes :id, :name, :created_at, :updated_at
+
+<% unless options.permission_name.blank? %>  has_many :<%= options.permission_name.pluralize %><% end %>
+<% unless options.role_name.blank? %>  has_many :<%= options.role_name.pluralize %><% end %>
+end

data/lib/generators/wildland_herd/organizations/templates/api_controller.rb

@@ -0,0 +1,8 @@
+module Api
+  module V1
+    class <%= class_name.pluralize %>Controller < BaseApiController
+
+    #Override default logic here
+    end
+  end
+end

data/lib/generators/wildland_herd/organizations/templates/factory_girl_factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :<%=  singular_name%> do
+    sequence(:name) { |n| "Organization #{n}" }
+  end
+end

data/lib/generators/wildland_herd/organizations/templates/migration.rb

@@ -0,0 +1,8 @@
+class WildlandHerdCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+      t.string :name, null: false, default: ''
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/wildland_herd/organizations/templates/model.rb

@@ -0,0 +1,7 @@
+class <%= class_name %> < ActiveRecord::Base
+  include WildlandHerd::ActsAsOrganization
+<% unless options.role_name.blank? %>  has_many :<%= options.role_name.pluralize %><% end %>
+<% unless options.permission_name.blank? %>  has_many :<%= options.permission_name.pluralize %>, through: :<%= options.role_name.pluralize %><% end %>
+
+  validates :name, uniqueness: true, presence: true
+end

data/lib/generators/wildland_herd/organizations/templates/pundit_policy.rb

@@ -0,0 +1,5 @@
+class <%= class_name %>Policy < ApplicationPolicy
+  def permitted_attributes
+    <%= attributes %>
+  end
+end

data/lib/generators/wildland_herd/permissions/permissions_generator.rb

@@ -0,0 +1,23 @@
+require 'generators/wildland_herd/base_resource_generator'
+
+module WildlandHerd
+  module Generators
+    class PermissionsGenerator < BaseResourceGenerator
+      source_root File.expand_path("../templates", __FILE__)
+      class_option :role_name, type: :string, default: 'role', description: 'TODO'
+      class_option :organization_name, type: :string, default: '', description: 'TODO'
+
+      protected
+
+      def role_table_name
+        options.role_name
+      end
+
+      def attributes
+        [:name, :permissible_type, :permissible_id, :can_create, :can_read, :can_update, :can_destroy].tap do |attrs|
+          attrs << :roles_id unless options.role_name.blank?
+        end
+      end
+    end
+  end
+end

data/lib/generators/wildland_herd/permissions/templates/active_model_serializer.rb

@@ -0,0 +1,7 @@
+class <%= class_name %>Serializer < ActiveModel::Serializer
+  embed :ids
+  attributes :id, :name, :permissible_type, :permissible_id,
+             :can_create, :can_read, :can_update, :can_destroy, :created_at, :updated_at
+
+<% unless options.role_name.blank? %>  has_one :<%= options.role_name %><% end %>
+end

data/lib/generators/wildland_herd/permissions/templates/api_controller.rb

@@ -0,0 +1,8 @@
+module Api
+  module V1
+    class <%= class_name.pluralize %>Controller < BaseApiController
+
+    #Override default logic here
+    end
+  end
+end

data/lib/generators/wildland_herd/permissions/templates/factory_girl_factory.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :<%=  singular_name%> do
+    sequence(:name) { |n| "Permission #{n}" }
+<% unless options.role_name.blank? %>    <%= options.role_name %><% end %>
+  end
+end

data/lib/generators/wildland_herd/permissions/templates/migration.rb

@@ -0,0 +1,15 @@
+class WildlandHerdCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+      t.string :name, null: false, default: ''
+      t.references :<%= role_table_name %>
+      t.string :permissible_type, default: nil
+      t.integer :permissible_id
+      t.boolean :can_create, default: false
+      t.boolean :can_read, default: false
+      t.boolean :can_update, default: false
+      t.boolean :can_destroy, default: false
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/wildland_herd/permissions/templates/model.rb

@@ -0,0 +1,5 @@
+class <%= class_name %> < ActiveRecord::Base
+  include WildlandHerd::ActsAsPermission
+<% unless options.role_name.blank? %>  belongs_to :<%= options.role_name %><% end %>
+<% unless options.organization_name.blank? %>  has_one :<%= options.organization_name %>, through: :<%= options.role_name %><% end %>
+end

data/lib/generators/wildland_herd/permissions/templates/pundit_policy.rb

@@ -0,0 +1,5 @@
+class <%= class_name %>Policy < ApplicationPolicy
+  def permitted_attributes
+    <%= attributes %>
+  end
+end

data/lib/generators/wildland_herd/roles/roles_generator.rb

@@ -0,0 +1,28 @@
+require 'generators/wildland_herd/base_resource_generator'
+
+module WildlandHerd
+  module Generators
+    class RolesGenerator < BaseResourceGenerator
+      source_root File.expand_path("../templates", __FILE__)
+      class_option :organization_name, type: :string, default: ''
+      class_option :permission_name, type: :string, default: 'permission'
+      class_option :enable_user_management, type: :boolean, default: true
+
+      protected
+
+      def organization_table_name
+        options.organization_name
+      end
+
+      def user_class_name
+        'user'
+      end
+
+      def attributes
+        [:name].tap do |attrs|
+          attrs << :organization_id unless options.organization_table_name.blank?
+        end
+      end
+    end
+  end
+end

data/lib/generators/wildland_herd/roles/templates/active_model_serializer.rb

@@ -0,0 +1,8 @@
+class <%= class_name %>Serializer < ActiveModel::Serializer
+  embed :ids
+  attributes :id, :name, :created_at, :updated_at
+
+<% unless options.permission_name.blank? %>  has_many :<%= options.permission_name.pluralize %><% end %>
+<% unless options.organization_name.blank? %>  has_one :<%= options.organization_name %><% end %>
+<% if options.enable_user_management %>  has_many :<%= user_class_name.pluralize %><% end %>
+end

data/lib/generators/wildland_herd/roles/templates/api_controller.rb

@@ -0,0 +1,8 @@
+module Api
+  module V1
+    class <%= class_name.pluralize %>Controller < BaseApiController
+
+    #Override default logic here
+    end
+  end
+end

data/lib/generators/wildland_herd/roles/templates/factory_girl_factory.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :<%=  singular_name%> do
+    sequence(:name) { |n| "Role #{n}" }
+<% unless organization_table_name.blank? %>    <%= options.organization_name %><% end %>
+  end
+end

data/lib/generators/wildland_herd/roles/templates/migration.rb

@@ -0,0 +1,9 @@
+class WildlandHerdCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+      t.string :name, null: false, default: ''
+<% unless organization_table_name.blank? %>      t.references :<%= organization_table_name %><% end %>
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/wildland_herd/roles/templates/model.rb

@@ -0,0 +1,8 @@
+class <%= class_name %> < ActiveRecord::Base
+  include WildlandHerd::ActsAsRole
+<% unless organization_table_name.blank? %>  belongs_to :<%= options.organization_name %><% end %>
+  has_many :<%= options.permission_name.pluralize %>
+<% if options.enable_user_management %>  has_many :<%= user_class_name.pluralize %> <% end %>
+
+  validates :name, presence: true
+end