boppers 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9c1ef7fe3d1fd71753d0742bac569898946b06d
-  data.tar.gz: ea5913553709cf5c4f99de4528631e1f92cd6570
+  metadata.gz: aacbc6cbb8092024b7e7bf778f6ebfff9f6ee73a
+  data.tar.gz: a23afe21e2c89027fd6c0a8a49f77ef53f0f5287
 SHA512:
-  metadata.gz: 26cc16a7fae673891da30498b58668ad2a29b25649f3b3d09bf47160e1457f57cd2871cf9b2d8c9e35767077e2dc3e427e9a504c7ac4035e4db7c7a88e78f86f
-  data.tar.gz: d0063d9ff6f74a381b7497385676520cfdc96048d29e2c743fff8aba2c97a784562b1a88e73b0a97f4bcdc26ed964f4666acf04c7b19d5e349ac8ee6976a3254
+  metadata.gz: ad2567a1c3b0b54ca93d42ea1410e5dc084f6aae3e037e2cff76fe4bd0d62b3d36750e811b7ddbea4d19fbfbfbd1460462b780429c3991be22ea8dda31c24c0c
+  data.tar.gz: 314e0a18f6ee0817abb788e52542ad2d38b9cb558121cc4676c1927efef80977aa3abd2248748df64ebdcbbbf7213aceea39c7ac3d38a2c3708fb949ba7dec35

data/README.md

@@ -65,7 +65,7 @@ The `Boppers.notify` method expects a event name (the recommended value is the b
 I encourage you to share your boppers. I even added a command to generate a common structure, so you don't have to think about how to organize it. Let's say you want to distribute the clock bopper above.
 
 ```
-$ boppers plugin clock
+$ boppers plugin clock --type bopper
       create  boppers-clock.gemspec
       create  gems.rb
       create  .gitignore
@@ -144,6 +144,10 @@ end
 
 Now this notifier will only be triggered when `Boppers.notify(:clock, *args)` is called, ignoring other boppers.
 
+### Distributing notifiers
+
+The idea is pretty much the same as creating a bopper. Use the command `boppers plugin [NAME] --type notifier` to generate a file structure. Then configure the plugin accordingly. There's a a linter for notifiers: `Boppers::Testing::NotifierLinter`.
+
 ### Available notifiers
 
 By default, Boppers comes with the following notifiers.
@@ -254,10 +258,6 @@ Boppers.configure do |config|
 end
 ```
 
-### Distributing notifiers
-
-The idea is pretty much the same. Create a new plugin with `boppers plugin [NAME]` and configure it accordingly. There's also a linter for notifiers: `Boppers::Testing::NotifierLinter`.
-
 ## Deploying to Heroku
 
 I'm assuming you installed the gem with `gem install boppers` and generated your app.

data/gems.locked

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boppers (0.0.5)
+    boppers (0.0.6)
       aitch
       thor
 

data/lib/boppers/cli.rb

@@ -28,14 +28,26 @@ module Boppers
     end
 
     desc "plugin NAME", "Create a new plugin for Boppers"
+    method_option :type,
+                  type: :string,
+                  desc: "The type of plugin. Can be either bopper or notifier.",
+                  required: true
 
     def plugin(name)
       require "boppers/generator/plugin"
 
+      unless %w{bopper notifier}.include?(options[:type])
+        message = "ERROR: --type needs to be either 'bopper' or 'notifier'"
+        shell.error shell.set_color(message, :red)
+        exit 1
+      end
+
+      suffix = "-notifier" if options[:type] == "notifier"
       base_path = File.dirname(File.expand_path(name))
-      base_name = "boppers-#{File.basename(name)}"
+      base_name = "boppers-#{File.basename(name)}#{suffix}"
 
       generator = Generator::Plugin.new
+      generator.plugin_type = options[:type]
       generator.destination_root = File.join(base_path, base_name)
       generator.invoke_all
     end

data/lib/boppers/generator/plugin.rb

@@ -5,6 +5,8 @@ module Boppers
     class Plugin < Thor::Group
       include Thor::Actions
 
+      attr_accessor :plugin_type
+
       desc "Generate a new Boopers plugin structure"
 
       def self.source_root
@@ -12,7 +14,7 @@ module Boppers
       end
 
       def copy_files
-        template "gemspec.erb", "#{plugin_name}.gemspec"
+        template "#{plugin_type}/gemspec.erb", "#{plugin_name}.gemspec"
         copy_file "gems.rb"
         copy_file ".gitignore"
         copy_file ".rubocop.yml"
@@ -20,20 +22,26 @@ module Boppers
         copy_file "CODE_OF_CONDUCT.md"
         copy_file "LICENSE.txt"
         copy_file "Rakefile"
-        template "README.erb", "README.md"
+        template "#{plugin_type}/README.erb", "README.md"
       end
 
       def copy_lib_files
-        template "lib/entry.erb", "lib/#{plugin_name}.rb"
-        template "lib/main.erb", "lib/boppers/#{name}.rb"
-        template "lib/version.erb", "lib/boppers/#{name}/version.rb"
+        template "#{plugin_type}/entry.erb",
+                 "lib/#{plugin_name}.rb"
+
+        template "#{plugin_type}/main.erb",
+                 "lib/boppers/#{plugin_dir}#{name}.rb"
+
+        template "#{plugin_type}/version.erb",
+                 "lib/boppers/#{plugin_dir}#{name}/version.rb"
       end
 
       def copy_test_files
         template "test/test_helper.erb", "test/test_helper.rb"
 
         test_file_name = name.tr("-", "_")
-        template "test/test_file.erb", "test/boppers/#{test_file_name}_test.rb"
+        template "#{plugin_type}/test_file.erb",
+                 "test/boppers/#{plugin_dir}#{test_file_name}_test.rb"
       end
 
       def run_commands
@@ -45,12 +53,18 @@ module Boppers
 
       private
 
+      def bopper?
+        plugin_type == "bopper"
+      end
+
       def plugin_name
         File.basename(destination_root)
       end
 
       def name
-        plugin_name.gsub(/^boppers-/, "")
+        plugin_name
+          .gsub(/^boppers-/, "")
+          .gsub(/-notifier$/, "")
       end
 
       def plugin_namespace
@@ -59,6 +73,10 @@ module Boppers
           .gsub(/_(.)/) { $1.upcase }
           .gsub(/^(.)/) { $1.upcase }
       end
+
+      def plugin_dir
+        "notifier/" unless bopper?
+      end
     end
   end
 end

data/lib/boppers/generator/plugin/{README.erb → bopper/README.erb}

@@ -1,5 +1,7 @@
 # Boppers::<%= plugin_namespace %>
 
+A [bopper](https://github.com/fnando/boppers) to [SOME DESCRIPTION].
+
 [![Travis-CI](https://travis-ci.org/[USERNAME]/<%= plugin_name %>.png)](https://travis-ci.org/[USERNAME]/<%= plugin_name %>)
 [![GPA](https://codeclimate.com/github/[USERNAME]/<%= plugin_name %>/badges/gpa.svg)](https://codeclimate.com/github/[USERNAME]/<%= plugin_name %>)
 [![Test Coverage](https://codeclimate.com/github/[USERNAME]/<%= plugin_name %>/badges/coverage.svg)](https://codeclimate.com/github/[USERNAME]/<%= plugin_name %>)

data/lib/boppers/generator/plugin/{gemspec.erb → bopper/gemspec.erb}

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Author"]
   spec.email         = ["author@example.com"]
 
-  spec.summary       = "Some description"
+  spec.summary       = "A bopper to [SOME DESCRIPTION]"
   spec.description   = spec.summary
   spec.homepage      = "https://rubygems.org/gems/<%= plugin_name %>"
   spec.license       = "MIT"

data/lib/boppers/generator/plugin/bopper/test_file.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class Boppers<%= plugin_namespace %>Test < Minitest::Test
+  test "lints plugin" do
+    bopper = Boppers::<%= plugin_namespace %>.new
+    Boppers::Testing::BopperLinter.call(bopper)
+  end
+end

data/lib/boppers/generator/plugin/notifier/README.erb

@@ -0,0 +1,47 @@
+# Boppers::Notifier::<%= plugin_namespace %>
+
+A [bopper](https://github.com/fnando/boppers) notifier to [SOME DESCRIPTION].
+
+[![Travis-CI](https://travis-ci.org/[USERNAME]/<%= plugin_name %>.png)](https://travis-ci.org/[USERNAME]/<%= plugin_name %>)
+[![GPA](https://codeclimate.com/github/[USERNAME]/<%= plugin_name %>/badges/gpa.svg)](https://codeclimate.com/github/[USERNAME]/<%= plugin_name %>)
+[![Test Coverage](https://codeclimate.com/github/[USERNAME]/<%= plugin_name %>/badges/coverage.svg)](https://codeclimate.com/github/[USERNAME]/<%= plugin_name %>)
+[![Gem](https://img.shields.io/gem/v/<%= plugin_name %>.svg)](https://rubygems.org/gems/<%= plugin_name %>)
+[![Gem](https://img.shields.io/gem/dt/<%= plugin_name %>.svg)](https://rubygems.org/gems/<%= plugin_name %>)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "<%= plugin_name %>"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install <%= plugin_name %>
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/<%= plugin_name %>. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Boppers project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/<%= plugin_name %>/blob/master/CODE_OF_CONDUCT.md).

data/lib/boppers/generator/plugin/notifier/entry.erb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "boppers"
+require "boppers/notifier/<%= name %>"

data/lib/boppers/generator/plugin/notifier/gemspec.erb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "./lib/boppers/notifier/<%= name %>/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "<%= plugin_name %>"
+  spec.version       = Boppers::Notifier::<%= plugin_namespace %>::VERSION
+  spec.authors       = ["Author"]
+  spec.email         = ["author@example.com"]
+
+  spec.summary       = "A bopper notifier to [SOME DESCRIPTION]"
+  spec.description   = spec.summary
+  spec.homepage      = "https://rubygems.org/gems/<%= plugin_name %>"
+  spec.license       = "MIT"
+
+  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 "boppers"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "simplecov"
+end

data/lib/boppers/generator/plugin/notifier/main.erb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "boppers/notifier/<%= name %>/version"
+
+module Boppers
+  module Notifier
+    class <%= plugin_namespace %>
+      attr_reader :subscribe
+
+      def initialize(subscribe: nil)
+        @subscribe = subscribe
+      end
+
+      def call(title, message, options)
+        puts "<%= name %> notification"
+      end
+    end
+  end
+end

data/lib/boppers/generator/plugin/notifier/test_file.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class BoppersNotifier<%= plugin_namespace %>Test < Minitest::Test
+  test "lints plugin" do
+    bopper = Boppers::Notifier::<%= plugin_namespace %>.new
+    Boppers::Testing::NotifierLinter.call(bopper)
+  end
+end

data/lib/boppers/generator/plugin/notifier/version.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Boppers
+  module Notifier
+    class <%= plugin_namespace %>
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/boppers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Boppers
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boppers
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -191,14 +191,20 @@ files:
 - lib/boppers/generator/plugin/.travis.yml
 - lib/boppers/generator/plugin/CODE_OF_CONDUCT.md
 - lib/boppers/generator/plugin/LICENSE.txt
-- lib/boppers/generator/plugin/README.erb
 - lib/boppers/generator/plugin/Rakefile
+- lib/boppers/generator/plugin/bopper/README.erb
+- lib/boppers/generator/plugin/bopper/entry.erb
+- lib/boppers/generator/plugin/bopper/gemspec.erb
+- lib/boppers/generator/plugin/bopper/main.erb
+- lib/boppers/generator/plugin/bopper/test_file.erb
+- lib/boppers/generator/plugin/bopper/version.erb
 - lib/boppers/generator/plugin/gems.rb
-- lib/boppers/generator/plugin/gemspec.erb
-- lib/boppers/generator/plugin/lib/entry.erb
-- lib/boppers/generator/plugin/lib/main.erb
-- lib/boppers/generator/plugin/lib/version.erb
-- lib/boppers/generator/plugin/test/test_file.erb
+- lib/boppers/generator/plugin/notifier/README.erb
+- lib/boppers/generator/plugin/notifier/entry.erb
+- lib/boppers/generator/plugin/notifier/gemspec.erb
+- lib/boppers/generator/plugin/notifier/main.erb
+- lib/boppers/generator/plugin/notifier/test_file.erb
+- lib/boppers/generator/plugin/notifier/version.erb
 - lib/boppers/generator/plugin/test/test_helper.erb
 - lib/boppers/http_client.rb
 - lib/boppers/notifier/hipchat.rb

data/lib/boppers/generator/plugin/test/test_file.erb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class Boppers<%= plugin_namespace %>Test < Minitest::Test
-  test "check version" do
-    assert_equal "0.1.0", Boppers::<%= plugin_namespace %>::VERSION
-  end
-end