acts_as_pluggable 0.1.0beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: ddb685fdf7ef9006e40f4a3aecdd7846fd7e1ba0
4
+ data.tar.gz: 98c446270c87e038d00b107fb12fc0f1ddeea8fb
5
+ SHA512:
6
+ metadata.gz: caed0179a0231c813f4c18d7976fd68d9410ab71ce2246ca10330e022e696133faa19b817a77d267e71a34733b3a68d9d52064cabbcba6ec3d5abb99bcd03db2
7
+ data.tar.gz: 02dc264e7bb7a78febf28537693bf210d0ed4dbf84ba1ce636389b035aae8388466a162ab98b7751c48e11ae3043d6d20b3c0a5789792775f74fccb205bcd6fe
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.2
4
+ before_install: gem install bundler -v 1.11.2
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at aboobackervyd@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in acts_as_pluggable.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Aboobacker MK
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,68 @@
1
+ # ActsAsPluggable
2
+
3
+ Make a rails app pluggable
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'acts_as_pluggable'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install acts_as_pluggable
20
+
21
+ ## Usage
22
+
23
+ Add following line in Gemfile
24
+ ```ruby
25
+ gem 'acts_as_pluggable',github: 'tachyons/acts_as_pluggable'
26
+ Dir[File.join(File.dirname(__FILE__), '/plugins/*')].each do |plugin_dir|
27
+ gem(File.basename(plugin_dir), path: plugin_dir)
28
+ end
29
+ ```
30
+
31
+ ```
32
+ rails plugin new 'plugins/sample_plugin --full'
33
+ ```
34
+
35
+ Now register plugin from engine.rb
36
+ Eg,
37
+ ```ruby
38
+ module SamplePlugin
39
+ class Engine < ::Rails::Engine
40
+ if defined?(ActsAsPluggable)
41
+ ::ActsAsPluggable::Plugin.register(:sample_plugin,:sample_tag,{
42
+ :engine=>self,
43
+ :description=>"sample description",
44
+ :website=> "https://github.com/tachyons/acts_as_pluggable",
45
+ :author=> "Aboobacker MK",
46
+ :version=>SamplePlugin::VERSION,
47
+ :settings=>{
48
+ :display_in_topbar=>true
49
+ }
50
+ })
51
+ end
52
+ end
53
+ end
54
+ ```
55
+ ## Development
56
+
57
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
58
+
59
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
60
+
61
+ ## Contributing
62
+
63
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/acts_as_pluggable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
64
+
65
+
66
+ ## License
67
+
68
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,31 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'acts_as_pluggable/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "acts_as_pluggable"
8
+ spec.version = ActsAsPluggable::VERSION
9
+ spec.authors = ["Aboobacker Mk"]
10
+ spec.email = ["aboobackervyd@gmail.com"]
11
+ spec.homepage = "http://aboobacker.in"
12
+ spec.summary = "Summary of ActsAsPluggable."
13
+ spec.description = "Description of ActsAsPluggable."
14
+ spec.license = "MIT"
15
+
16
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
17
+ # delete this section to allow pushing this gem to any host.
18
+
19
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.11"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ spec.add_dependency "rails", "> 4.2"
28
+ spec.add_dependency 'activemodel', '>= 3.0'
29
+
30
+
31
+ end
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "acts_as_pluggable"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,8 @@
1
+ require "acts_as_pluggable/version"
2
+ require "acts_as_pluggable/plugin"
3
+ require "acts_as_pluggable/errors"
4
+
5
+ module ActsAsPluggable
6
+
7
+ # Your code goes here...
8
+ end
@@ -0,0 +1,4 @@
1
+ module ActsAsPluggable
2
+ class PluginNotFound < StandardError; end
3
+ class DuplicatePlugin < StandardError; end
4
+ end
@@ -0,0 +1,59 @@
1
+ require 'active_model'
2
+ module ActsAsPluggable
3
+ class Plugin
4
+ attr_accessor :id,:tag,:name,:description,:website,:author,:version,:settings
5
+ extend Enumerable
6
+ include ActiveModel::Validations
7
+ validates :id, presence: true
8
+
9
+ @@registered_plugins = {}
10
+ @meta_data={}
11
+ def initialize(id,tag,meta_data={})
12
+ @id=id
13
+ @tag=tag
14
+ @meta_data=meta_data
15
+ set_instance_variables_from_hash(@meta_data)
16
+ return self
17
+ end
18
+ def engine
19
+ @meta_data[:engine]
20
+ end
21
+ def self.register(id, tag=nil, meta_data={})
22
+ raise DuplicatePlugin if Plugin.find_by_id(id)
23
+ plugin=Plugin.new(id,tag,meta_data)
24
+ if plugin.valid?
25
+ @@registered_plugins[id]= plugin
26
+ else
27
+ return false
28
+ end
29
+ end
30
+ def self.find(id)
31
+ plugin=@@registered_plugins[id]
32
+ raise PluginNotFound if plugin.nil?
33
+ end
34
+ #Do not raise exception here
35
+ def self.find_by_id(id)
36
+ plugin=@@registered_plugins[id]
37
+ end
38
+ def self.find_all_by_tag(tag)
39
+ @@registered_plugins.values.select{|p|p.tag == tag.to_s}
40
+ end
41
+ def self.all
42
+ @@registered_plugins
43
+ end
44
+ def <=>(plugin)
45
+ self.id.to_s <=> plugin.id.to_s
46
+ end
47
+ def self.each(&block)
48
+ @@registered_plugins.values.each do |plugin|
49
+ block.call(plugin)
50
+ end
51
+ end
52
+ private
53
+ def set_instance_variables_from_hash(hash)
54
+ hash.each do |k,v|
55
+ instance_variable_set("@#{k}",v)
56
+ end
57
+ end
58
+ end
59
+ end
@@ -0,0 +1,3 @@
1
+ module ActsAsPluggable
2
+ VERSION = "0.1.0beta1"
3
+ end
@@ -0,0 +1,17 @@
1
+ module ActsAsPluggable
2
+ module Generators
3
+ class InstallGenerator < Rails::Generators::Base
4
+ def create_initializer_file
5
+ create_file "config/initializers/acts_as_pluggable.rb", "# Add initialization content here"
6
+ end
7
+ def add_plugins_to_gemfile
8
+ inject_into_file 'Gemfile', after: "acts_as_pluggable\n" do <<-'RUBY'
9
+ Dir.entries('plugins').select {|f| !File.directory? f}.each do |plugin|
10
+ gem plugin, path: 'plugins/'+plugin
11
+ end
12
+ RUBY
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
metadata ADDED
@@ -0,0 +1,130 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: acts_as_pluggable
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0beta1
5
+ platform: ruby
6
+ authors:
7
+ - Aboobacker Mk
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-05-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.11'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.11'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rails
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">"
60
+ - !ruby/object:Gem::Version
61
+ version: '4.2'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">"
67
+ - !ruby/object:Gem::Version
68
+ version: '4.2'
69
+ - !ruby/object:Gem::Dependency
70
+ name: activemodel
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '3.0'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '3.0'
83
+ description: Description of ActsAsPluggable.
84
+ email:
85
+ - aboobackervyd@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - acts_as_pluggable.gemspec
99
+ - bin/console
100
+ - bin/setup
101
+ - lib/acts_as_pluggable.rb
102
+ - lib/acts_as_pluggable/errors.rb
103
+ - lib/acts_as_pluggable/plugin.rb
104
+ - lib/acts_as_pluggable/version.rb
105
+ - lib/generators/acts_as_pluggable/install_generator.rb
106
+ homepage: http://aboobacker.in
107
+ licenses:
108
+ - MIT
109
+ metadata: {}
110
+ post_install_message:
111
+ rdoc_options: []
112
+ require_paths:
113
+ - lib
114
+ required_ruby_version: !ruby/object:Gem::Requirement
115
+ requirements:
116
+ - - ">="
117
+ - !ruby/object:Gem::Version
118
+ version: '0'
119
+ required_rubygems_version: !ruby/object:Gem::Requirement
120
+ requirements:
121
+ - - ">"
122
+ - !ruby/object:Gem::Version
123
+ version: 1.3.1
124
+ requirements: []
125
+ rubyforge_project:
126
+ rubygems_version: 2.4.8
127
+ signing_key:
128
+ specification_version: 4
129
+ summary: Summary of ActsAsPluggable.
130
+ test_files: []