syosset-plugins-base 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0312b92486f63db2b3ab8010cae06c3b0389830
+  data.tar.gz: 27f57d20807fc5aa6cbbcdf8d38ce07df9a9cc44
+SHA512:
+  metadata.gz: e408a991b30a7877a4dbf8d8b931f86d705d28875e716524187f39548af423f7be2d8a0d22003af517db1f3444ed8a18b8fa58e64bfc768bef605660cc13b506
+  data.tar.gz: 2928fa3b5e8769cce50a296ede06ce0426fd290088b7ab7f30d22727c64da4c4cde1f673654b19d7f832b494932e507322d5b17c20c50f6f388427678c2db047

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in syosset-plugins-base.gemspec
+gemspec

data/README.md

@@ -0,0 +1,27 @@
+# Syosset::Plugins::Base
+
+This is the base code for a plugin system designed to autoload "plugins" (Rails Engines) in `vendor/plugins` which follow a certain convention.
+
+TODO: Document this convention
+See https://github.com/Syosset/syosset to see this plugin framework in use.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'syosset-plugins-base'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install syosset-plugins-base
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/syosset-plugins-base.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "syosset/plugins/base"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/app/models/concerns/plugable.rb

@@ -0,0 +1,10 @@
+module Concerns
+  # Models which can have plugins should inclue this concern
+  module Plugable
+    extend ActiveSupport::Concern
+
+    included do
+      field :enabled_plugins, type: Array, default: []
+    end
+  end
+end

data/lib/syosset/plugins/base.rb

@@ -0,0 +1,14 @@
+require "syosset/plugins/base/version"
+require "active_support"
+require "app/models/concerns/plugable"
+
+module Syosset
+  module Plugins
+    module Base
+        extend ::ActiveSupport::Autoload
+
+        autoload :Plugin
+        autoload :Registry
+    end
+  end
+end

data/lib/syosset/plugins/base/plugin.rb

@@ -0,0 +1,34 @@
+module Syosset
+  module Plugins
+    module Base
+      # The plugin's main class (Rails engine entrypoint) should include this module
+      # Note: Inclusion is not enough; you must register the plugin with the registry
+      module Plugin
+        extend ActiveSupport::Concern
+
+        included do
+          cattr_accessor :plugin_name, :plugin_description
+        end
+
+        module ClassMethods
+          # Sets the plugin name
+          def name(name)
+            self.plugin_name = name
+          end
+
+          # Sets the plugin's usage
+          def description(description)
+            self.plugin_description = description
+          end
+
+          # Includes a module into a concern which all plugables use
+          # This is useful if you want to define relations into models which can have plugins
+          # Example: A photo gallery plugin might need to define a relation like department has_many :images
+          def plugable_include(mod)
+            Concerns::Plugable.include(mod)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/syosset/plugins/base/railtie.rb

@@ -0,0 +1,31 @@
+module Syosset
+  module Plugins
+    module Base
+      class Railtie < Rails::Railtie
+        config.after_initialize do
+          logger = Logger.new(STDOUT)
+
+          logger.info "Loading plugins..."
+          Dir[Rails.root.to_s + '/vendor/plugins/**/*.rb'].each do |file|
+            path = file.split("/")
+            if path[-1] == "engine.rb"
+              logger.info "Loading #{file}"
+              require file
+
+              plugin = "Syosset::Plugins::#{path[-2].camelize}::Engine".constantize
+              Registry.register plugin
+              logger.info  "Added #{plugin} to Registry"
+
+              logger.info  "Attempting to mount on /plugins/#{plugin.plugin_name.parameterize}"
+              Rails.application.routes.draw do
+                mount plugin => "/plugins/#{plugin.plugin_name.parameterize}"
+              end
+
+              logger.info  "Loaded #{plugin.plugin_name} { #{plugin.plugin_description} }"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/syosset/plugins/base/registry.rb

@@ -0,0 +1,48 @@
+module Syosset
+  module Plugins
+    module Base
+      module Registry
+        mattr_accessor :plugins, :callbacks
+        @@plugins = []
+        @@callbacks = {on_register: [], on_enable: [], on_disable: []}
+
+        def self.register(klass, options = {})
+          @@plugins << [klass, options]
+          @@callbacks[:on_register].each {|x| x.call }
+        end
+
+        def self.enabled? plugin_class, plugable
+          raise "Plugin must include Syosset::Plugins::Base::Plugin" unless plugin_class.include? Syosset::Plugins::Base::Plugin
+          raise "Plugable must include Concerns::Plugable" unless plugable.class.include? Concerns::Plugable
+          plugable.enabled_plugins.include? plugin_class.to_s
+        end
+
+        def self.enable plugin_class, plugable
+          raise "Plugin must include Syosset::Plugins::Base::Plugin" unless plugin_class.include? Syosset::Plugins::Base::Plugin
+          raise "Plugable must include Concerns::Plugable" unless plugable.class.include? Concerns::Plugable
+          plugable.enabled_plugins << plugin_class.to_s
+          @@callbacks[:on_enable].each {|x| x.call(plugin_class) } if plugable.save
+        end
+
+        def self.disable plugin_class, plugable
+          raise "Plugin must include Syosset::Plugins::Base::Plugin" unless plugin_class.include? Syosset::Plugins::Base::Plugin
+          raise "Plugable must include Concerns::Plugable" unless plugable.class.include? Concerns::Plugable
+          plugable.enabled_plugins.delete(plugin_class.to_s)
+          @@callbacks[:on_disable].each {|x| x.call(plugin_class) } if plugable.save
+        end
+
+        def self.on_register(&callback)
+          @@callbacks[:on_register] << callback
+        end
+
+        def self.on_enable(&callback)
+          @@callbacks[:on_enable] << callback
+        end
+
+        def self.on_disable(&callback)
+          @@callbacks[:on_disable] << callback
+        end
+      end
+    end
+  end
+end

data/lib/syosset/plugins/base/version.rb

@@ -0,0 +1,7 @@
+module Syosset
+  module Plugins
+    module Base
+      VERSION = "0.1.0"
+    end
+  end
+end

data/syosset-plugins-base.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "syosset/plugins/base/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "syosset-plugins-base"
+  spec.version       = Syosset::Plugins::Base::VERSION
+  spec.authors       = ["Neil Johari"]
+  spec.email         = ["neil@johari.tech"]
+
+  spec.summary       = %q{Base of the plugin management system used at syosseths.com}
+  spec.description   = %{Provides base classes for plugins, and includes railtie to autoload plugins}
+  spec.homepage      = "https://github.com/Syosset/syosset-plugins-base"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "mongoid", "~> 6.1.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: syosset-plugins-base
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neil Johari
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+description: Provides base classes for plugins, and includes railtie to autoload plugins
+email:
+- neil@johari.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/app/models/concerns/plugable.rb
+- lib/syosset/plugins/base.rb
+- lib/syosset/plugins/base/plugin.rb
+- lib/syosset/plugins/base/railtie.rb
+- lib/syosset/plugins/base/registry.rb
+- lib/syosset/plugins/base/version.rb
+- syosset-plugins-base.gemspec
+homepage: https://github.com/Syosset/syosset-plugins-base
+licenses: []
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Base of the plugin management system used at syosseths.com
+test_files: []