mikutter_plugin_base 0.0.1

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.
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in mikutter_plugin_base.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Taiki ONO
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,50 @@
1
+ # MikutterPluginBase
2
+
3
+ Add new way to write mikutter plugin.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your mikutter's Gemfile:
8
+
9
+ gem 'mikutter_plugin_base'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install mikutter_plugin_base
18
+
19
+ Finally execute mikkuter with bundled gems:
20
+
21
+ $ bundle exec ruby mikkuter.rb
22
+
23
+ ## Usage
24
+
25
+ ```ruby
26
+ # path/to/mikutter/plugin/dir/sample.rb
27
+
28
+ class Sample < Mikutter::PluginBase
29
+ def run(plugin)
30
+ "write your code here."
31
+ "you can access mikutter plugin api via `plugin`."
32
+ end
33
+
34
+ def on_update(service, messages)
35
+ "define mikutter event callbacks, hooks, filters as method."
36
+ "plugin base will automatically add them."
37
+ end
38
+ end
39
+
40
+ # at last of your plugin script do `resister!`
41
+ Sample.register!
42
+ ```
43
+
44
+ ## Contributing
45
+
46
+ 1. Fork it
47
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
48
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
49
+ 4. Push to the branch (`git push origin my-new-feature`)
50
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,3 @@
1
+ module MikutterPluginBase
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,36 @@
1
+ require "mikutter_plugin_base/version"
2
+
3
+ module Mikutter
4
+ class PlugingBase
5
+ class << self
6
+ def register!
7
+ name = self.class.to_s.downcase.to_sym
8
+ instance = new
9
+ procedure = lambda do |plugin|
10
+ instance.method(:run).to_proc.call(
11
+ instance.method(:add_events).to_proc.call(plugin)
12
+ )
13
+ end
14
+ ::Plugin.create name, &procedure
15
+ end
16
+ end
17
+
18
+ def add_events(plugin)
19
+ methods.each do |name|
20
+ case name.to_s
21
+ when /^on_?(.+)$/
22
+ plugin.add_event $1, &method(name).to_proc
23
+ when /^filter_?(.+)$/
24
+ plugin.add_filter $1, &method(name).to_proc
25
+ when /^hook_?(.+)$/
26
+ plugin.add_event_hook $1, &method(name).to_proc
27
+ end
28
+ end
29
+ plugin
30
+ end
31
+
32
+ def run(plugin)
33
+ raise NotImplementedError
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,19 @@
1
+ # -*- encoding: utf-8 -*-
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'mikutter_plugin_base/version'
5
+
6
+ Gem::Specification.new do |gem|
7
+ gem.name = "mikutter_plugin_base"
8
+ gem.version = MikutterPluginBase::VERSION
9
+ gem.authors = ["Taiki ONO"]
10
+ gem.email = ["taiks.4559@gmail.com"]
11
+ gem.description = %q{Write mikutter plugin using module system.}
12
+ gem.summary = %q{Add new way to write mikutter plugin.}
13
+ gem.homepage = ""
14
+
15
+ gem.files = `git ls-files`.split($/)
16
+ gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
17
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
18
+ gem.require_paths = ["lib"]
19
+ end
metadata ADDED
@@ -0,0 +1,54 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: mikutter_plugin_base
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Taiki ONO
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2013-02-17 00:00:00.000000000 Z
13
+ dependencies: []
14
+ description: Write mikutter plugin using module system.
15
+ email:
16
+ - taiks.4559@gmail.com
17
+ executables: []
18
+ extensions: []
19
+ extra_rdoc_files: []
20
+ files:
21
+ - .gitignore
22
+ - Gemfile
23
+ - LICENSE.txt
24
+ - README.md
25
+ - Rakefile
26
+ - lib/mikutter_plugin_base.rb
27
+ - lib/mikutter_plugin_base/version.rb
28
+ - mikutter_plugin_base.gemspec
29
+ homepage: ''
30
+ licenses: []
31
+ post_install_message:
32
+ rdoc_options: []
33
+ require_paths:
34
+ - lib
35
+ required_ruby_version: !ruby/object:Gem::Requirement
36
+ none: false
37
+ requirements:
38
+ - - ! '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ required_rubygems_version: !ruby/object:Gem::Requirement
42
+ none: false
43
+ requirements:
44
+ - - ! '>='
45
+ - !ruby/object:Gem::Version
46
+ version: '0'
47
+ requirements: []
48
+ rubyforge_project:
49
+ rubygems_version: 1.8.23
50
+ signing_key:
51
+ specification_version: 3
52
+ summary: Add new way to write mikutter plugin.
53
+ test_files: []
54
+ has_rdoc: