orchparty 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1457e581b4223905242191ad8c8c8af33a7315f0
-  data.tar.gz: 8cdc21be1791bdd231e6b14fa80bb85e9987a1f6
+  metadata.gz: b2ccdea8159a378436eaf3a11787bacf9535f8ad
+  data.tar.gz: 3dba4a2eefd4c7939dff7a96a27b4fb3b04d19d1
 SHA512:
-  metadata.gz: dfc51ef7fb8e5a343545c6a053ac57cda2301a4a8c3f2f897db6a08e9d32d34bc005af15953f52324f6297573bd412c69457006de35a83d1d022beae8ca97d64
-  data.tar.gz: 776a740d2943f4ef606812c67cbaf4ccbf66d4e0cdd20c8bf1f5284e92842f1bb0c179314a0fb2dfdd8cc61457a62d61d479fb8fe3744af7a2e35fecd6b15fcc
+  metadata.gz: 7754f19348534203cf89552abbd3dd8288380770e1e5045e1735ec1196b4ab49caadc4c96cd7c9f93d3da302b240bd60e15e00ff19015224f9e4c2eb4a3e78bc
+  data.tar.gz: f770f266217b8131e7cfff17952ab49f3a1d54cf19af52465d57dd8942fbcd6710a4798cfad6222683f28d295ea407b596ce580d9916bdc0474f6af012162df0

data/.dockerignore

@@ -0,0 +1 @@
+Dockerfile

data/Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:2.3.1-slim
+RUN apt-get update && apt-get install -y git
+RUN mkdir /orchparty
+WORKDIR /orchparty
+ADD Gemfile .
+ADD Gemfile.lock .
+ADD orchparty.gemspec .
+ADD lib lib
+ADD .git .git
+RUN bundle install --without development test
+ADD . .
+RUN rake install
+COPY docker-entrypoint /usr/local/bin/
+ENTRYPOINT ["/bin/sh", "docker-entrypoint"]

data/README.md

@@ -83,6 +83,8 @@ Maybe for the future it is possible to run the gem in a docker container, so no
 
 ## Usage
 
+### CLI
+
 See the commandline usage instrucution by running:
 
     $ orchparty help
@@ -90,7 +92,41 @@ See the commandline usage instrucution by running:
  For generating eg. use:
 
     
-    $ orchparty g stack.rb docker-compose.yml my-cool-app -g docker_compose_v2
+    $ orchparty generate docker_compose_v2 -f stack.rb -o docker-compose.yml -a my-cool-app
+
+### In your own piece of code
+
+```ruby
+require 'orchparty'
+
+# load the generator plugin you want to use
+Orchparty.plugin :docker_compose_v1
+
+Orchparty.generate(:docker_compose_v1,
+                     # all options that are needed for orchparty to transform
+                     # your input to a plain hash for generating
+                    {filename: "path/to/input_file.rb",
+                     application: "application_name_to_generate" },
+                     # all options that are needed for the plugin
+                    {output: "path/to/output_file.yml"})
+```
+
+### In your own piece of code
+
+```ruby
+require 'orchparty'
+
+# load the generator plugin you want to use
+Orchparty.plugin :docker_compose_v1
+
+Orchparty.generate(:docker_compose_v1,
+                     # all options that are needed for orchparty to transform
+                     # your input to a plain hash for generating
+                    {filename: "path/to/input_file.rb",
+                     application: "application_name_to_generate" },
+                     # all options that are needed for the plugin
+                    {output: "path/to/output_file.yml"})
+```
 
 ## DSL spec
 
@@ -341,6 +377,72 @@ application 'app_perf-prod' do
 end
 ```
 
+## Plugins
+
+Orchparty allows you to write own generators via a Plugin system. Also the
+buildin generators like docker_compose_v1 and docker_compose_v2 generators are
+only plugins. 
+
+To build your own plugin create a ruby gem with a Plugin
+configuration under lib/orchparty/plugin/#{plugin_name}.rb
+
+### Example Plugin:
+```ruby
+
+module Orchparty
+  module Plugin
+    class DockerComposeV1
+
+      def self.desc
+        # this description is shown in the cli
+        "generate docker-compose v1 file"
+      end
+
+      def self.define_flags(c)
+        # give add all flags that your Generator needs
+        # see [davetron5000/gli](https://github.com/davetron5000/gli) for
+        # documentatino of flags
+        c.flag [:output,:o], required: true, :desc => 'Set the output file'
+      end
+
+      def self.generate(application, options)
+        # Orchparty will pass the compiled application hash and all options
+        # that you required in define_flags.
+        # Here is the place where you can write your generation logic
+        File.write(options[:output], output(application))
+      end
+
+      private
+      def self.output(ast)
+        ast.services.map do |name, service|
+          service = service.to_h
+          service.delete(:mix)
+          [service.delete(:name), HashUtils.deep_stringify_keys(service.to_h)]
+        end.to_h.to_yaml
+      end
+
+    end
+  end
+end
+
+# register your plugin
+Orchparty::Plugin.register_plugin(:docker_compose_v1, Orchparty::Plugin::DockerComposeV1)
+```
+
+### Plugin Usage:
+
+#### CLI
+The CLI tries to load all plugins that you have installed as gem by using
+Gem::Specification.
+
+
+#### Code
+
+If you use orchparty as part of a own application load a plugin via:
+
+```ruby
+Orchparty.plugin(:docker_compose_v1)
+```
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :upload_docker do
+  `docker build . `
+
+end

data/docker-entrypoint

@@ -0,0 +1,2 @@
+#!/bin/bash
+cd "/rootfs${ROOT_PWD}" && orchparty $@

data/exe/orchparty

@@ -1,15 +1,2 @@
 #!/usr/bin/env ruby
-require "thor"
-require "orchparty"
-
-class OrchPartyCommand < Thor
-  desc "generate INPUT_FILE OUTPUT_FILE APPLICATION_NAME", "generates a configuration file for an application"
-  method_option :generator, :aliases => "-g", default: "docker_compose_v1", :desc => "Which generator to take"
-  method_option :aliases => "g"
-  def generate(input_file, output_file, application_name)
-    generator = options[:generator] || "docker_compose_v1"
-    File.write(output_file, Orchparty.send(generator.to_sym, input_file, application_name))
-  end
-end
-
-OrchPartyCommand.start
+require "orchparty/cli"

data/lib/orchparty/cli.rb

@@ -0,0 +1,33 @@
+require 'orchparty'
+require 'gli'
+
+Orchparty.load_all_available_plugins
+
+class OrchPartyApp
+  extend GLI::App
+
+  program_desc 'Write your orchestration configuration with a Ruby DSL that allows you to have mixins, imports and variables.'
+  version Orchparty::VERSION
+
+  subcommand_option_handling :normal
+
+  desc "Compiles a Orchparty input file to a orchestration framework configuration"
+  command :generate do |com|
+    Orchparty.plugins.each do |name, plugin|
+        com.desc plugin.desc
+        com.command(name) do |plugin_command|
+          plugin_command.flag [:filename,:f,'file-name'], required: true, :desc => 'The Orchparty input file'
+          plugin_command.flag [:application,:a], required: true, :desc => 'The application that should be compiled'
+          plugin.define_flags(plugin_command)
+          plugin_command.action do |global_options,plugin_options,args|
+            options = plugin_options.delete(GLI::Command::PARENT)
+            options[:application] = plugin_options[:application]
+            options[:filename] = plugin_options[:filename]
+            Orchparty.generate(name, options, plugin_options)
+          end
+        end
+    end
+  end
+end
+
+exit OrchPartyApp.run(ARGV)

data/lib/orchparty/plugin.rb

@@ -0,0 +1,24 @@
+module Orchparty
+  module Plugin
+    @plugins = {}
+
+    def self.load_plugin(name)
+      begin
+        require "orchparty/plugins/#{name}"
+        raise "Plugin didn't correctly register itself" unless @plugins[name]
+        @plugins[name]
+      rescue LoadError
+        puts "could not load the plugin #{name}, you might install it as a gem or you need to write it by your self ;)"
+        false
+      end
+    end
+
+    def self.plugins
+      @plugins
+    end
+
+    def self.register_plugin(name, mod)
+      @plugins[name] = mod
+    end
+  end
+end

data/lib/orchparty/plugins/docker_compose_v1.rb

@@ -0,0 +1,34 @@
+module Orchparty
+  module Plugin
+    class DockerComposeV1
+
+      def self.desc
+        "generate docker-compose v1 file"
+      end
+
+      def self.define_flags(c)
+        c.flag [:output,:o], :desc => 'Set the output file'
+      end
+
+      def self.generate(ast, options)
+        output = output(ast)
+        if options[:output]
+          File.write(options[:output], output)
+        else
+          puts output
+        end
+      end
+
+      def self.output(ast)
+        ast.services.map do |name, service|
+          service = service.to_h
+          service.delete(:mix)
+          [service.delete(:name), HashUtils.deep_stringify_keys(service.to_h)]
+        end.to_h.to_yaml
+      end
+
+    end
+  end
+end
+
+Orchparty::Plugin.register_plugin(:docker_compose_v1, Orchparty::Plugin::DockerComposeV1)

data/lib/orchparty/{generators → plugins}/docker_compose_v2.rb

@@ -1,19 +1,31 @@
 require 'yaml'
 module Orchparty
-  module Generators
-    class DockerComposeV2
-      attr_reader :ast
-      def initialize(ast)
-        @ast = ast
+  module Plugin
+    module DockerComposeV2
+
+      def self.desc
+        "generate docker-compose v2 file"
+      end
+
+      def self.define_flags(c)
+        c.flag [:output,:o], :desc => 'Set the output file'
       end
 
-      def transform_to_yaml(hash)
+      def self.generate(ast, options)
+        output = output(ast)
+        if options[:output]
+          File.write(options[:output], output)
+        else
+          puts output
+        end
+      end
+
+      def self.transform_to_yaml(hash)
         hash = hash.deep_transform_values{|v| v.is_a?(Hash) ? v.to_h : v }
         HashUtils.deep_stringify_keys(hash)
       end
 
-      def output(application_name)
-        application = ast.applications[application_name]
+      def self.output(application)
         {"version" => "2", 
          "services" =>
         application.services.map do |name,service|
@@ -24,7 +36,8 @@ module Orchparty
          "networks" => transform_to_yaml(application.networks),
         }.to_yaml
       end
-
     end
   end
 end
+
+Orchparty::Plugin.register_plugin(:docker_compose_v2, Orchparty::Plugin::DockerComposeV2)

data/lib/orchparty/version.rb

@@ -1,3 +1,3 @@
 module Orchparty
-  VERSION = "0.3.1"
+  VERSION = "1.0.0"
 end

data/lib/orchparty.rb

@@ -3,22 +3,31 @@ require "orchparty/version"
 require "orchparty/ast"
 require "orchparty/context"
 require "orchparty/transformations"
-require "orchparty/generators"
 require "orchparty/dsl_parser"
+require "orchparty/plugin"
 require "hash"
 
 module Orchparty
 
+  def self.load_all_available_plugins
+    Gem::Specification.map {|f| f.matches_for_glob("orchparty/plugins/*.rb") }.flatten.map{|file_name| File.basename(file_name, ".*").to_sym }.each do |plugin_name|
+      plugin(plugin_name)
+    end
+  end
+
+  def self.plugins
+    Orchparty::Plugin.plugins
+  end
 
-  def self.ast(input_file)
-    Transformations.transform(Orchparty::DSLParser.new(input_file).parse)
+  def self.plugin(name)
+    Orchparty::Plugin.load_plugin(name)
   end
 
-  def self.docker_compose_v1(input_file, application_name)
-    Orchparty::Generators::DockerComposeV1.new(ast(input_file)).output(application_name)
+  def self.ast(filename: , application:)
+    Transformations.transform(Orchparty::DSLParser.new(filename).parse).applications[application]
   end
 
-  def self.docker_compose_v2(input_file, application_name)
-    Orchparty::Generators::DockerComposeV2.new(ast(input_file)).output(application_name)
+  def self.generate(plugin_name, options, plugin_options)
+    plugins[plugin_name].generate(ast(filename: options[:filename], application: options[:application]), plugin_options)
   end
 end

data/orchparty.gemspec

@@ -25,8 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "hashie", "~> 3.5.6"
-  spec.add_dependency "thor", "~> 0.19.4"
-  spec.add_dependency 'psych', '~> 2.2', '>= 2.2.4'
+  spec.add_dependency "gli", "~> 2.16.0"
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchparty
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jannis Huebl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -25,39 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.5.6
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: 2.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.4
-- !ruby/object:Gem::Dependency
-  name: psych
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.4
+        version: 2.16.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -110,11 +90,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - CNAME
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE
 - README.md
@@ -122,16 +104,18 @@ files:
 - _config.yml
 - bin/console
 - bin/setup
+- docker-entrypoint
 - exe/orchparty
 - lib/deep_merge.rb
 - lib/hash.rb
 - lib/orchparty.rb
 - lib/orchparty/ast.rb
+- lib/orchparty/cli.rb
 - lib/orchparty/context.rb
 - lib/orchparty/dsl_parser.rb
-- lib/orchparty/generators.rb
-- lib/orchparty/generators/docker_compose_v1.rb
-- lib/orchparty/generators/docker_compose_v2.rb
+- lib/orchparty/plugin.rb
+- lib/orchparty/plugins/docker_compose_v1.rb
+- lib/orchparty/plugins/docker_compose_v2.rb
 - lib/orchparty/transformations.rb
 - lib/orchparty/transformations/all.rb
 - lib/orchparty/transformations/mixin.rb

data/lib/orchparty/generators/docker_compose_v1.rb

@@ -1,20 +0,0 @@
-require 'psych'
-module Orchparty
-  module Generators
-    class DockerComposeV1
-      attr_reader :ast
-      def initialize(ast)
-        @ast = ast
-      end
-
-      def output(application_name)
-        Psych.dump(ast.applications[application_name].services.map do |name, service|
-          service = service.to_h
-          service.delete(:mix)
-          [service.delete(:name), HashUtils.deep_stringify_keys(service.to_h)]
-        end.to_h)
-      end
-
-    end
-  end
-end

data/lib/orchparty/generators.rb

@@ -1,7 +0,0 @@
-require 'orchparty/generators/docker_compose_v1'
-require 'orchparty/generators/docker_compose_v2'
-
-module Orchparty
-  module Generators
-  end
-end