flow-yml-parser 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10230f71d919b423a6ca1d74254eaa53fcd1571f
+  data.tar.gz: 383f0b181b0b8e2183119f0eeda5e0b9f8724c32
+SHA512:
+  metadata.gz: a8c01ee2284bb9b05f524f7eda526f674a5ad6a66c143d2213c7b4f9ee7749b16a6040ecb1397157be01f4a536c6b5b148e2aa6bb6e505a2fa041b3a2f406918
+  data.tar.gz: fa87085ebfd27523b7edf2408f079ebb6af1554e10eb76c7abe8bd517467799e76a91295714de9892a3c7bf585e0edf287c111e04b04cdb384837a84be732f04

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    flow-yml-parser (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  flow-yml-parser!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.13.6

data/README.md

@@ -0,0 +1,36 @@
+# Flow::Yml::Parser
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/flow/yml/parser`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flow-yml-parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flow-yml-parser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/flow-yml-parser.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flow/yml/parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flow-yml-parser.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flow-yml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flow-yml-parser"
+  spec.version       = FlowYml::Parser::VERSION
+  spec.authors       = ["yang.guo"]
+  spec.email         = ["gy@fir.im"]
+
+  spec.summary       = %q{flow.ci config parser}
+  spec.description   = %q{flow.ci config parser}
+  spec.homepage      = "http://www.flow.ci"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  # This gem will work with 1.8.6 or greater...
+  spec.required_ruby_version = '>= 2.2.0'
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/flow-yml-parser.rb

@@ -0,0 +1 @@
+require 'flow-yml/parser'

data/lib/flow-yml/converter.rb

@@ -0,0 +1,168 @@
+# encoding: utf-8
+require 'flow-yml/exceptions'
+require 'flow-yml/domain/config_base'
+require 'flow-yml/domain/fields'
+require 'flow-yml/domain/project'
+require 'flow-yml/domain/step'
+require 'flow-yml/domain/flow_pipeline'
+
+module FlowYml
+
+  class ConverterBase
+    attr_reader :yml_obj
+
+    def initialize(yml_obj)
+      raise YmlObjectMissingException.new if yml_obj.nil?
+      @yml_obj = yml_obj
+    end
+
+    def convert
+      raise NotImplementedError.new('ConverterBase..')
+    end
+
+    protected
+
+    def converter(meta_obj, yml_obj)
+      meta_obj.class.meta.each do |name, meta|
+        next if meta.skip
+
+        value = yml_obj[name]
+        value = yml_obj[name.to_s] if value.nil?
+
+        raise RequiredFieldMissingException.new(name) if value_missing?(meta, value)
+        next if value.nil?
+
+        raise YmlTypeException.new(meta.type, name) if type_miss_match?(meta, value)
+        case meta.type
+          when FlowYml::Domain::Fields::TYPE_ARRAY
+            meta_obj.send("#{name}=", convert_list(meta, value))
+
+          when FlowYml::Domain::Fields::TYPE_HASH
+            meta_obj.send("#{name}=", convert_hash(meta, value))
+
+          else
+            meta_obj.send("#{name}=", value)
+        end
+      end
+    end
+
+    def convert_list(meta, value)
+      obj_list = []
+      value.each do |item|
+        # add object to list if converter defined
+        if converter_defined?(meta)
+          converter = Object.const_get(converter_name(meta)).new(item)
+          obj_list.push(converter.convert)
+          next
+        end
+
+        # add item to list directly
+        obj_list.push(item)
+      end
+      obj_list
+    end
+
+    def convert_hash(meta, value)
+      # TODO convert value to object
+    end
+
+    # get target converter name
+    def converter_name(meta)
+      "FlowYml::#{meta.target}Converter"
+    end
+
+    # check target converter is defined
+    def converter_defined?(meta)
+      Object.const_defined?(converter_name(meta))
+    end
+
+    # check yml value whether nil and required
+    # return:
+    #   true = if value is missing
+    #   false = if value not required
+    def value_missing?(meta, value)
+      return false unless meta.required
+
+      ## check array type
+      return value.count == 0 if !value.nil? && value.class.to_s == FlowYml::Domain::Fields::TYPE_ARRAY
+
+      value.nil?
+    end
+
+    # check yml value is match the required type
+    # return:
+    #   true = if type missing match
+    #   false = if type is match
+    def type_miss_match?(meta, value)
+      meta.type.split('|').each do |type_str|
+        return false if value.class.to_s == type_str
+      end
+      true
+    end
+
+  end
+
+  # Project yml converter
+  class ProjectConverter < ConverterBase
+
+    def initialize(yml_obj)
+      super(yml_obj)
+    end
+
+    def convert
+      project = FlowYml::Domain::Project.new
+      converter(project, @yml_obj)
+      project
+    end
+
+  end
+
+  # Flow yml converter
+  class FlowConverter < ConverterBase
+
+    def initialize(yml_obj)
+      super(yml_obj)
+    end
+
+    def convert
+      flow = FlowYml::Domain::FlowPipeline.new
+      converter(flow, @yml_obj)
+      flow
+    end
+  end
+
+  # Step yml converter
+  class StepConverter < ConverterBase
+
+    def initialize(yml_obj)
+      super(yml_obj)
+    end
+
+    def convert
+      step = FlowYml::Domain::Step.new
+      converter(step, yml_adapter)
+      step
+    end
+
+    # convert to standard yml format
+    #   from: - {step name}
+    #           - command
+    #           - command
+    #   to:   -
+    #           name: {step name}
+    #           scripts:
+    #             - command
+    #             - command
+    def yml_adapter
+      raise YmlTypeException.new('Hash', 'Step') if @yml_obj.class.to_s != FlowYml::Domain::Fields::TYPE_HASH
+
+      step_name = @yml_obj.keys[0]
+      step_script = @yml_obj.values[0]
+      raise RequiredFieldMissingException.new('name') if step_name.nil?
+      raise RequiredFieldMissingException.new('scripts') if step_script.nil? || step_script.empty?
+
+      {:name => step_name, :scripts => step_script}
+    end
+  end
+
+end

data/lib/flow-yml/domain/config_base.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'flow-yml/domain/fields'
+
+module FlowYml
+  module Domain
+
+    # Base Config to define attributes which can be overwrite by sub config
+    # Config level
+    # - project
+    #   - flow
+    class ConfigBase
+      include FlowYml::Domain::Fields
+
+      # optional fields
+      field :docker, type: TYPE_STRING, required: false
+      field :sudo, type: "#{TYPE_TRUE}|#{TYPE_FALSE}", required: false, default: false
+      field :install, type: TYPE_ARRAY, required: false, default: nil, target: TYPE_STRING
+    end
+  end
+end

data/lib/flow-yml/domain/fields.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+
+module FlowYml
+  module Domain
+    module Fields
+
+      TYPE_STRING = 'String'
+      TYPE_ARRAY = 'Array'
+      TYPE_HASH = 'Hash'
+      TYPE_TRUE = 'TrueClass'
+      TYPE_FALSE = 'FalseClass'
+
+      TYPE_FLOW = 'Flow'
+      TYPE_STEP = 'Step'
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # Field meta definition of yml
+      #   name:Symbol = object name
+      #   type:String = related yml type, ex: {String, Hash, Array, TrueClass|FalseClass}
+      #   required:Boolean = is required in yml
+      #   value:Object = default value of field
+      #   target:String = Class of Hash value or Array Item
+      #   skip:Boolean = skip this field
+      class YmlFieldMeta
+        attr_accessor :name,
+                      :type,
+                      :required,
+                      :value,
+                      :target,
+                      :skip
+
+        def initialize(name, type, required, value, target, skip)
+          @name = name
+          @type = type
+          @required = required
+          @value = value
+          @target = target
+          @skip = skip
+        end
+      end
+
+      module ClassMethods
+        def field(name, options = {})
+          add_meta(name, options)
+          add_attribute(name)
+        end
+
+        def add_meta(name, options)
+          meta = Fields::YmlFieldMeta.new(name,
+                                          options[:type],
+                                          options[:required],
+                                          options[:default],
+                                          options[:target],
+                                          options[:skip])
+
+          self.instance_eval do
+
+            # init meta data
+            @meta = {} if @meta.nil?
+            @meta[name] = meta
+
+            # merge superclass meta data
+            @meta = @meta.merge(self.superclass.meta) if self.superclass.methods.include? :meta
+
+            def meta
+              @meta
+            end
+          end
+        end
+
+        def add_attribute(symbol)
+          raw = %Q{
+              def #{symbol}
+                return @#{symbol} unless @#{symbol}.nil?
+                self.class.meta[:#{symbol}].value
+              end
+
+              def #{symbol}=(value)
+                @#{symbol} = value
+              end
+            }
+          self.class_eval(raw)
+        end
+      end
+    end
+  end
+end

data/lib/flow-yml/domain/flow_pipeline.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+require 'flow-yml/domain/fields'
+
+module FlowYml
+  module Domain
+
+    class FlowPipeline < ConfigBase
+      include FlowYml::Domain::Fields
+
+      field :branch, type: TYPE_STRING, required: true
+      field :steps, type: TYPE_ARRAY, required: true, target: TYPE_STEP
+    end
+  end
+end

data/lib/flow-yml/domain/project.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module FlowYml
+  module Domain
+
+    # Project level configuration
+    class Project < ConfigBase
+      include FlowYml::Domain::Fields
+
+      # required fields
+      field :project, type: TYPE_STRING, required: true
+      field :language, type: TYPE_STRING, required: true
+      field :install, type: TYPE_ARRAY, required: false, target: TYPE_STRING
+      field :flows, type: TYPE_ARRAY, required: true, target: TYPE_FLOW
+    end
+  end
+end
+

data/lib/flow-yml/domain/step.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+require 'flow-yml/domain/fields'
+
+module FlowYml
+  module Domain
+
+    class Step
+      include FlowYml::Domain::Fields
+
+      field :name, type: TYPE_STRING, required: true
+      field :scripts, type: TYPE_ARRAY, required: true, target: TYPE_STRING
+    end
+  end
+end

data/lib/flow-yml/exceptions.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module FlowYml
+
+  # Required yml field is missing
+  class RequiredFieldMissingException < Exception
+    def initialize(field)
+      super("Required yml field '#{field}' is missing")
+    end
+  end
+
+  # Yml field type is wrong
+  class YmlTypeException < Exception
+    def initialize(type, field)
+      super("Required '#{type}' for yml field '#{field}'")
+    end
+  end
+
+  # Yml object is missing
+  class YmlObjectMissingException < Exception
+    def initialize
+      super('Yml object cannot be nil')
+    end
+  end
+end

data/lib/flow-yml/parser.rb

@@ -0,0 +1,23 @@
+require 'flow-yml/version'
+require 'flow-yml/converter'
+require 'yaml'
+
+module FlowYml
+
+  # main entry of flow yml parser to analysis and convert
+  # yml config to project object
+  class Parser
+    attr_reader :content
+
+    def initialize(content)
+      @content = content
+    end
+
+    # build yml file and return project object
+    def build
+      yml_obj = YAML::load(@content)
+      converter = FlowYml::ProjectConverter.new(yml_obj)
+      converter.convert
+    end
+  end
+end

data/lib/flow-yml/version.rb

@@ -0,0 +1,5 @@
+module FlowYml
+  class Parser
+    VERSION = '0.1.3'
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: flow-yml-parser
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- yang.guo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: flow.ci config parser
+email:
+- gy@fir.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flow-yml-parser.gemspec
+- lib/flow-yml-parser.rb
+- lib/flow-yml/converter.rb
+- lib/flow-yml/domain/config_base.rb
+- lib/flow-yml/domain/fields.rb
+- lib/flow-yml/domain/flow_pipeline.rb
+- lib/flow-yml/domain/project.rb
+- lib/flow-yml/domain/step.rb
+- lib/flow-yml/exceptions.rb
+- lib/flow-yml/parser.rb
+- lib/flow-yml/version.rb
+homepage: http://www.flow.ci
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: flow.ci config parser
+test_files: []