oo-cartridge-tools 0.1 → 0.2

data/README.md

@@ -1,4 +1,9 @@
-# OpenShift Cartridge Lint
+# OpenShift Cartridge Tools
+
+This is a set of tools that makes the OpenShift cartridge/quickstart developers
+life easier.
+
+## oo-cartridge-lint
 
 The OpenShift Cartridge Lint is an utility which helps developers to test
 the validity and syntax of the cartridge metadata.
@@ -9,23 +14,6 @@ you haven't missed some required attribute or you not made the syntax error.
 
 ## Using oo-cartridge-lint
 
-### Dependencies:
-
-* [kwalify](http://www.kuwata-lab.com/kwalify)
-* [commander](http://visionmedia.github.io/commander)
-
-(Don't worry, these dependencies are installed automatically for you)
-
-### Installation:
-
-```
-$ gem install oo-cartridge-lint
-```
-
-(the Fedora/RHEL packages are TBD)
-
-### Usage:
-
 To check your current cartridge, you can run the following command:
 
 ```
@@ -44,3 +32,33 @@ sample output might look like this:
 ```
 
 (Note: The --file option is optional, by default the command will check the `metadata/manifest.yml` path.
+
+## oo-cartridge-create
+
+This command will create and prepare directory with DIY cartridge. It is
+basically a bootstrap script for the new cartridge.
+
+## Using oo-cartridge-create
+
+```
+$ oo-cartridge-create diy --name openshift-sidekiq-cartridge
+Cartridge-Short-Name (eg. "redis"): sidekiq
+Version: 1.0
+The './openshift-sidekiq-cartridge/' cartridge was succesfully created...
+```
+
+The 'openshift-sidekiq-cartridge' directory will then contain a DIY cartridge
+bootstrap and you could start adding your code into it.
+
+### Dependencies:
+
+* [kwalify](http://www.kuwata-lab.com/kwalify)
+* [commander](http://visionmedia.github.io/commander)
+
+(Don't worry, these dependencies are installed automatically for you)
+
+### Installation:
+
+```
+$ gem install oo-cartridge-tools
+```

data/bin/oo-cartridge-create

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+
+require_relative '../lib/openshift/cartridge_tools'
+
+program :name, 'OpenShift DIY cartridge creator'
+program :version, '1.0.0'
+program :description, 'Bootstrap a new DIY cartridge'
+
+command :diy do |c|
+  c.syntax = 'diy'
+  c.description = 'Create new cartridge based on the official OpenShift DIY cartridge'
+  c.option '--name NAME', String, 'Name of the new cartridge (eg. openshift-redis-cartridge)'
+
+  c.action do |_, options|
+    unless options.name
+      say "ERROR: Please specify the cartridge name using --name option."
+      exit(255)
+    end
+    OpenShift::CartridgeTools::Diy.init_cartridge_dir(options.name)
+    opts = {}
+    opts[:short_name] = ask('Cartridge-Short-Name (eg. "redis"): ')
+    opts[:version] = ask('Version: ')
+    OpenShift::CartridgeTools::Diy.parse_bin(options.name, opts)
+    OpenShift::CartridgeTools::Diy.parse_docs(options.name, opts)
+    OpenShift::CartridgeTools::Diy.parse_spec(options.name, opts)
+    OpenShift::CartridgeTools::Diy.parse_manifest(options.name, opts)
+    OpenShift::CartridgeTools::Diy.git_keep(options.name)
+    say "The './#{options.name}/' cartridge was succesfully created..."
+  end
+
+end

data/bin/oo-cartridge-lint

@@ -3,7 +3,7 @@
 require 'rubygems'
 require 'commander/import'
 
-require_relative '../lib/openshift/cartridge_utils'
+require_relative '../lib/openshift/cartridge_tools'
 
 program :name, 'OpenShift cartridge lint'
 program :version, '1.0.0'
@@ -16,9 +16,9 @@ command :manifest do |c|
   c.option '--schema STRING', String, 'Override the manifest.yaml kwalify schema'
 
   c.action do |_, options|
-    manifest_file = OpenShift::CartridgeUtils::Lint.guess_manifest_path(options.file)
-    schema_file = OpenShift::CartridgeUtils::Lint.guess_schema_path(options.schema)
-    result = OpenShift::CartridgeUtils::Lint.parse(manifest_file, schema_file)
+    manifest_file = OpenShift::CartridgeTools::Lint.guess_manifest_path(options.file)
+    schema_file = OpenShift::CartridgeTools::Lint.guess_schema_path(options.schema)
+    result = OpenShift::CartridgeTools::Lint.parse(manifest_file, schema_file)
     if result.errors?
       say "[#{manifest_file}] INVALID"
       result.errors.each { |e| say "  [#{e.path}] - #{e.message}" }

data/lib/openshift/cartridge_tools.rb

@@ -1,5 +1,6 @@
 module OpenShift
   module CartridgeTools
     require_relative './cartridge_tools/lint'
+    require_relative './cartridge_tools/diy'
   end
 end

data/lib/openshift/cartridge_tools/diy.rb

@@ -0,0 +1,73 @@
+require 'fileutils'
+require 'erb'
+
+module OpenShift
+  module CartridgeTools
+    class Diy
+
+      TEMPLATE_DIR = File.join(File.dirname(__FILE__), '..', '..', '..', 'schema', 'templates', 'diy')
+
+      def self.init_cartridge_dir(directory_name)
+        FileUtils.mkdir_p(directory_name)
+        Dir.chdir(directory_name) do
+          ['bin', 'configuration/etc/conf.d', 'env', 'hooks', 'metadata', 'usr'].each do |f|
+            FileUtils.mkdir_p(f)
+          end
+        end
+      end
+
+      def self.parse_bin(directory_name, options={})
+        Dir.chdir(directory_name) do
+          control_template = ERB.new(File.read(File.join(TEMPLATE_DIR, 'bin/control.erb')))
+          File.open('bin/control', 'w') { |f| f.write(control_template.result(binding)) }
+          FileUtils.chmod(0755, 'bin/control')
+          setup_template = ERB.new(File.read(File.join(TEMPLATE_DIR, 'bin/setup.erb')))
+          File.open('bin/setup', 'w') { |f| f.write(setup_template.result(binding)) }
+          FileUtils.chmod(0755, 'bin/setup')
+        end
+      end
+
+      def self.parse_docs(directory_name, options={})
+        Dir.chdir(directory_name) do
+          FileUtils.cp(File.join(TEMPLATE_DIR, 'COPYRIGHT'), '.')
+          FileUtils.cp(File.join(TEMPLATE_DIR, 'LICENSE'), '.')
+          File.open('README.md', 'w') { |f| f.write("#{options[:short_name].capitalize} OpenShift Cartridge") }
+        end
+      end
+
+      def self.parse_spec(directory_name, options={})
+        Dir.chdir(directory_name) do
+          spec_template = ERB.new(File.read(File.join(TEMPLATE_DIR, 'openshift-diy-cartridge.spec.erb')))
+          File.open("#{directory_name}.spec", 'w') { |f| f.write(spec_template.result(binding)) }
+        end
+      end
+
+      def self.parse_manifest(directory_name, options={})
+        Dir.chdir(directory_name) do
+          manifest = YAML::load_file(File.join(TEMPLATE_DIR, 'metadata', 'manifest.yml'))
+          manifest.merge!({
+            'Name' => options[:short_name],
+            'Cartridge-Short-Name' => options[:short_name].upcase,
+            'Version' => options[:version],
+            'Cartridge-Version' => '0.0.1',
+            'Compatible-Versions' => [],
+            'Cart-Data' => [],
+            'Provides' => [ options[:short_name], "#{options[:short_name]}-#{options[:version]}"]
+          })
+          File.write('metadata/manifest.yml', YAML::dump(manifest))
+          FileUtils.cp(File.join(TEMPLATE_DIR, 'metadata/managed_files.yml'), 'metadata/')
+        end
+      end
+
+      def self.git_keep(directory_name)
+        Dir.chdir(directory_name) do
+          FileUtils.touch('env/.gitkeep')
+          FileUtils.touch('configuration/etc/conf.d/.gitkeep')
+          FileUtils.touch('hooks/.gitkeep')
+          FileUtils.touch('usr/.gitkeep')
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oo-cartridge-tools
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -48,12 +48,15 @@ email:
 - mfojtik@redhat.com
 executables:
 - oo-cartridge-lint
+- oo-cartridge-create
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/openshift/cartridge_tools.rb
 - lib/openshift/cartridge_tools/lint.rb
+- lib/openshift/cartridge_tools/diy.rb
 - bin/oo-cartridge-lint
+- bin/oo-cartridge-create
 - schema/manifest_schema_20130929.yml
 - README.md
 homepage: https://github.com/mfojtik/oo-cartridge-tools