bosh-plugin-pipeline 0.2.0

data/lib/bosh/plugin_generator/helpers.rb

@@ -0,0 +1,106 @@
+require 'git'
+require 'bosh/versions'
+
+module Bosh
+  module PluginGenerator
+    module Helpers
+
+      attr_accessor :plugin_name, :plugin_folder, :lib_folder, :helpers_folder,
+                    :commands_folder, :bosh_version
+
+      extend Forwardable
+      include Bosh::Versions::Helpers
+      def_delegator :@generator, :generate
+
+      def extract_options(plugin_name)
+        @plugin_name     = plugin_name
+        @plugin_folder   = plugin_name
+        @bosh_version    = bosh_gem_latest_version
+        @license_type    = options[:license]
+        @lib_folder      = File.join(plugin_name, 'lib', 'bosh')
+        @spec_folder     = File.join(plugin_name, 'spec')
+        @helpers_folder  = File.join(lib_folder, short_plugin_name)
+        @commands_folder = File.join(lib_folder, 'cli', 'commands')
+
+        default_context = {
+          email: Git.global_config["user.email"],
+          author: Git.global_config["user.name"],
+          description: "Short description.",
+          license: nil,
+          full_plugin_name: full_plugin_name,
+          short_plugin_name: short_plugin_name,
+          class_name: short_plugin_name.split('_').collect(&:capitalize).join,
+          bosh_version: bosh_version
+        }
+        context = default_context.merge(options)
+        raise "You need to specify email and author" if context[:email].nil? || context[:author].nil?
+        templates_folder = File.expand_path("../../../../templates", __FILE__)
+        @generator = Bosh::PluginGenerator::Generator.new(context, source_folder: templates_folder)
+      end
+      
+      def generate_files
+        generate_command_class
+        generate_helpers
+        generate_version
+        generate_gemspec
+        generate_readme
+        generate_license if license?
+        generate_developer_environment
+      end
+
+      private
+
+      def full_plugin_name
+        return @full_plugin_name if @full_plugin_name
+        separator = plugin_name.include?('_') ? '_' : '-'
+        @full_plugin_name = plugin_name.start_with?('bosh') ? plugin_name : ['bosh', plugin_name].join(separator)
+      end
+
+      def short_plugin_name
+        @short_plugin_name ||= plugin_name.gsub(/^bosh[_-]/, '')
+      end
+
+      def license?
+        !!@license_type
+      end
+
+      def generate_command_class
+        generate('main.rb.erb', File.join(lib_folder, "#{short_plugin_name}.rb"))
+        generate('cli/commands/command.rb.erb', File.join(commands_folder, "#{short_plugin_name}.rb"))
+      end
+
+      def generate_helpers
+        generate('helpers_folder/helpers.rb.erb', File.join(helpers_folder, 'helpers.rb'))
+      end
+
+      def generate_version
+        generate('helpers_folder/version.rb.erb', File.join(helpers_folder, 'version.rb'))
+      end
+
+      def generate_gemspec
+        generate('gemspec.erb', File.join(plugin_name, "#{full_plugin_name}.gemspec"))
+      end
+
+      def generate_readme
+        generate('README.md.erb', File.join(plugin_name, 'README.md'))
+      end
+
+      def generate_license
+        generate("licenses/#{@license_type}.txt", File.join(plugin_name, 'LICENSE'))
+      end
+
+      def generate_developer_environment
+        generate('Gemfile', File.join(plugin_folder, 'Gemfile'))
+        generate('Rakefile', File.join(plugin_folder, 'Rakefile'))
+        generate('spec/spec_helper.rb', File.join(@spec_folder, 'spec_helper.rb'))
+        generate('spec/command_spec.rb', File.join(@spec_folder, 'command_spec.rb'))
+        generate('spec/.rspec', File.join(plugin_folder, '.rspec'))
+        generate('.gitignore', File.join(plugin_folder, '.gitignore'))
+        generate('.ruby-version.erb', File.join(plugin_folder, '.ruby-version'))
+        generate('.ruby-gemset.erb', File.join(plugin_folder, '.ruby-gemset'))
+        generate('.travis.yml', File.join(plugin_folder, '.travis.yml'))
+      end
+
+    end
+  end
+end

data/lib/bosh/plugin_generator.rb

@@ -0,0 +1,11 @@
+require "cli"
+require "cli/core_ext"
+
+module Bosh
+  module PluginGenerator
+    include BoshExtensions
+  end
+end
+
+require "bosh/plugin_generator/generator"
+require "bosh/plugin_generator/helpers"

data/lib/bosh/plugin_pipeline/version.rb

@@ -0,0 +1,5 @@
+module Bosh
+  module PluginPipeline
+    VERSION = '0.2.0'
+  end
+end

data/spec/assets/simple-template.txt

@@ -0,0 +1,3 @@
+I needed to put something here, so here is my question :
+
+How many people can read hex if only <%= people.join(', ') %> and dead people can read hex?

data/spec/plugin_generator/generator_spec.rb

@@ -0,0 +1,25 @@
+describe Bosh::PluginGenerator::Generator do
+  let(:context) { { people: ['you', 'me'] } }
+  let(:tmpdir) { Dir.mktmpdir }
+  let(:target) { File.join(tmpdir, 'subfolder-1', 'subfolder-2', 'result.txt') }
+  subject { Bosh::PluginGenerator::Generator.new(context, source_folder: File.expand_path('../../assets', __FILE__)) }
+  after { FileUtils.remove_entry_secure tmpdir }
+
+  describe '#generate' do
+    before do
+      subject.generate('simple-template.txt', target)
+    end
+
+    context 'simple template' do 
+
+      it 'creates file with folder' do
+        expect(File).to exist(target)
+      end
+      
+      it 'creates renders ERB' do
+        expect(File.read(target)).to match(/you, me/)
+      end
+      
+    end
+  end
+end

data/spec/plugin_generator_spec.rb

@@ -0,0 +1,85 @@
+describe 'bosh generate plugin' do
+
+  describe 'magic command' do
+
+    before(:context) do
+      @current_dir = Dir.pwd
+      @tmpdir = Dir.mktmpdir
+      Dir.chdir(@tmpdir)
+    end
+
+    after(:context) do
+      Dir.chdir(@current_dir)
+      FileUtils.remove_entry_secure(@tmpdir)
+    end
+
+    context 'without parameters and "bosh-" preffix' do
+      let(:plugin_folder) { File.join(Dir.pwd, 'magic') }
+
+      before(:all) do
+        system('bosh generate plugin magic > /dev/null')
+      end
+
+      it 'creates gem with "bosh-" prefix' do
+        gemspec_file = File.join(plugin_folder, 'bosh-magic.gemspec')
+        expect(File).to exist(gemspec_file)
+        expect(File.read(gemspec_file)).to match(/bosh-magic/)
+      end
+
+      it 'generates gemspec with email from Git setup' do
+        expect(File.read("#{plugin_folder}/bosh-magic.gemspec")).to include(Git.global_config["user.name"])
+        expect(File.read("#{plugin_folder}/bosh-magic.gemspec")).to include(Git.global_config["user.email"])
+      end
+
+      it 'has no license file' do
+        expect(File).not_to exist(File.join(plugin_folder, 'LICENSE'))
+      end
+
+      it 'has initialized git repository' do
+        expect(File).to exist(File.join(plugin_folder, '.git'))
+      end
+
+      it 'can run rspec on generated plugin (using rake command)' do
+        Dir.chdir(plugin_folder) do
+          Bundler.with_clean_env do
+            system('bundle exec rake')
+          end
+        end
+        expect($?.exitstatus).to eq(0)
+      end
+
+    end
+
+    context 'with parameters, license and "bosh-" prefix' do
+      let(:plugin_folder) { File.join(Dir.pwd, 'bosh-magic') }
+
+      before(:all) do
+        command = <<-CMD 
+                         bosh generate plugin bosh-magic --email=gandalf@email.com \
+                                                         --author=Gandalf          \
+                                                         --license=mit > /dev/null
+CMD
+        system(command)
+      end
+
+      it 'creates folder with the name specified as plugin a name' do
+        expect(File).to exist(plugin_folder)
+      end
+
+      it 'creates gem with 'bosh-' prefix' do
+        gemspec_file = File.join(plugin_folder, 'bosh-magic.gemspec')
+        expect(File).to exist(gemspec_file)
+        expect(File.read(gemspec_file)).to match(/bosh-magic/)
+      end
+
+      it 'generates gemspec with correct email' do
+        expect(File.read("#{plugin_folder}/bosh-magic.gemspec")).to match(/gandalf@email.com/)
+      end
+
+      it 'creates license file' do
+        expect(File).to exist(File.join(plugin_folder, 'LICENSE'))
+      end
+
+    end    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test)
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+
+require "rspec/core"
+require "rspec/its"
+
+require "bosh/plugin_generator"
+
+def asset_file(*path)
+  assets_file = File.expand_path("../assets", __FILE__)
+  File.join(assets_file, *path)
+end

data/templates/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.ruby-gemset
+.ruby-version

data/templates/.ruby-gemset.erb

@@ -0,0 +1 @@
+<%= full_plugin_name %>

data/templates/.ruby-version.erb

@@ -0,0 +1 @@
+<%= RUBY_VERSION %>

data/templates/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+before_install:
+ - sudo apt-get update -qq --fix-missing
+rvm:
+  - 2.1.5
+  - 2.2.3

data/templates/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bosh-plugin.gemspec
+gemspec

data/templates/README.md.erb

@@ -0,0 +1,33 @@
+# Bosh plugin generator
+
+<%= description || 'Short description here.' %>
+
+## What is BOSH?
+
+BOSH orchestrates initial deployments and ongoing updates that are: predictable, repeatable, reliable, self-healing, infrastructure-agnostic. You can take a look on [BOSH project on GitHub](https://github.com/cloudfoundry/bosh) and read more details in [docs](http://docs.cloudfoundry.org/bosh/).
+
+## How to install
+```
+gem install <%= full_plugin_name %>
+```
+
+## How to use
+```
+bosh say hello
+```
+
+## How to publish gems
+
+See [this notes](http://guides.rubygems.org/publishing/) to know how to publish your gem.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Notes
+
+Generated by [BOSH plugin generator](https://github.com/Altoros/bosh-plugin-generator)

data/templates/Rakefile

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

data/templates/cli/commands/command.rb.erb

@@ -0,0 +1,14 @@
+require "bosh/<%= short_plugin_name %>"
+
+module Bosh::Cli::Command
+  class <%= class_name %> < Base
+    include Bosh::<%= class_name %>::Helpers
+
+    usage "say hello"
+    desc "simple BOSH CLI plugin"
+    def perform
+      say_hello
+    end
+
+  end
+end

data/templates/gemspec.erb

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bosh/<%= short_plugin_name %>/version'
+bosh_version = '<%= bosh_version %>'
+
+Gem::Specification.new do |spec|
+  spec.name          = '<%= full_plugin_name %>'
+  spec.version       = Bosh::<%= class_name %>::VERSION
+  spec.authors       = ['<%= author %>']
+  spec.email         = ['<%= email %>']
+  spec.description   = %q{<%= description %>}
+  spec.summary       = %q{<%= description %>}
+  spec.homepage      = 'https://github.com/cloudfoundry/bosh'
+  <%- if license %>
+  spec.license       = '<%= license.upcase %>'
+  <% end %>
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency 'bosh_cli',  ">= #{bosh_version}"
+  spec.add_runtime_dependency 'bosh_common',  ">= #{bosh_version}"
+  spec.add_runtime_dependency 'membrane', '~> 1.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rspec', '~> 3.3.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.2.0'
+  spec.add_development_dependency 'rake', '~> 10.4.2'
+  spec.add_development_dependency 'rubocop', '~> 0.34.2'
+end

data/templates/helpers_folder/helpers.rb.erb

@@ -0,0 +1,11 @@
+module Bosh
+  module <%= class_name %>
+    module Helpers
+
+      def say_hello
+        say "Hello, world!".make_green
+      end
+
+    end
+  end
+end

data/templates/helpers_folder/version.rb.erb

@@ -0,0 +1,5 @@
+module Bosh
+  module <%= class_name %>
+    VERSION = "0.0.1"
+  end
+end

data/templates/licenses/apache2.txt

@@ -0,0 +1,13 @@
+   Copyright <%= Date.today.year %> <%= "#{author} <#{email}>" %>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/templates/licenses/gpl.txt

@@ -0,0 +1,15 @@
+    <%= description %>
+    Copyright (C)  <%= Date.today.year %> <%= "#{author} <#{email}>" %>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/templates/licenses/lgpl.txt

@@ -0,0 +1,8 @@
+<%= description %>
+Copyright (C)  <%= Date.today.year %> <%= "#{author} <#{email}>" %>
+
+This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

data/templates/licenses/mit.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <%= Date.today.year %> <%= "#{author} <#{email}>" %>
+
+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/templates/main.rb.erb

@@ -0,0 +1,11 @@
+require "cli"
+require "cli/validation"
+
+module Bosh
+  module <%= class_name %>
+    include BoshExtensions
+  end
+end
+
+require "bosh/<%= short_plugin_name %>/helpers"
+require "bosh/<%= short_plugin_name %>/version"

data/templates/spec/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/templates/spec/command_spec.rb

@@ -0,0 +1,11 @@
+describe "bosh say hello" do
+
+  before do
+    system("bosh say hello > /dev/null")
+  end
+
+  it "exits without errors" do
+    expect($?.exitstatus).to eq(0)
+  end
+
+end

data/templates/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test)
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+
+require "rspec/core"
+require "rspec/its"
+
+require "bosh/<%= short_plugin_name %>"