clerq 0.2.0 → 0.3.0

data/lib/clerq/services/service.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+module Clerq
+  module Services
+
+    class Service
+      def self.call(*args)
+        new(*args).call
+      end
+
+      private_class_method :new
+
+      # Should be implemented in subclasses
+      def call
+      end
+    end
+
+  end
+end

data/lib/clerq/version.rb

@@ -1,3 +1,3 @@
 module Clerq
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clerq
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nikolay Voynov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-23 00:00:00.000000000 Z
+date: 2019-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,18 +83,26 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- TODO.md
 - bin/console
 - bin/setup
 - clerq.gemspec
+- clerq.thor
+- docs/README.md
+- docs/_config.yml
 - exe/clerq
 - lib/assets/knb/SRS-IEEE-830-1998.md
 - lib/assets/knb/SRS-RUP.md
+- lib/assets/knb/business-case.md
 - lib/assets/knb/ears-with-examples.md
 - lib/assets/knb/problem-statement.md
 - lib/assets/knb/product-statement.md
 - lib/assets/knb/requirement-attributes.md
+- lib/assets/knb/requirement-life-cycle.md
 - lib/assets/knb/use-case.md
+- lib/assets/knb/vision-document.md
+- lib/assets/lib/clerq_doc.thor
+- lib/assets/lib/colonize_repo.rb
+- lib/assets/lib/spec/colonize_repo_spec.rb
 - lib/assets/new/README.md.tt
 - lib/assets/new/clerq.thor.tt
 - lib/assets/new/clerq.yml.tt
@@ -127,20 +135,21 @@ files:
 - lib/clerq/cli.rb
 - lib/clerq/entities.rb
 - lib/clerq/entities/node.rb
-- lib/clerq/interactors.rb
-- lib/clerq/interactors/check_assembly.rb
-- lib/clerq/interactors/create_node.rb
-- lib/clerq/interactors/interactor.rb
-- lib/clerq/interactors/query_assembly.rb
-- lib/clerq/interactors/query_template.rb
-- lib/clerq/interactors/render_assembly.rb
 - lib/clerq/properties.rb
-- lib/clerq/render_erb.rb
 - lib/clerq/repositories.rb
 - lib/clerq/repositories/file_repository.rb
-- lib/clerq/repositories/node_reader.rb
 - lib/clerq/repositories/node_repository.rb
 - lib/clerq/repositories/text_repository.rb
+- lib/clerq/services.rb
+- lib/clerq/services/check_assembly.rb
+- lib/clerq/services/create_node.rb
+- lib/clerq/services/load_assembly.rb
+- lib/clerq/services/query_node.rb
+- lib/clerq/services/query_template.rb
+- lib/clerq/services/read_node.rb
+- lib/clerq/services/render_erb.rb
+- lib/clerq/services/render_node.rb
+- lib/clerq/services/service.rb
 - lib/clerq/settings.rb
 - lib/clerq/version.rb
 homepage: https://github.com/nvoynov/clerq

data/TODO.md

@@ -1,7 +0,0 @@
-# TODO
-
-[ ] Return node file name from NodeRepository and CreateNode
-[ ] Provide CheckAssembly with checking links with partial ids e.g. `[[*.entiity]]`   
-[ ] Provide separate MarkupNode in `lib` with minitest specs
-[ ] Auto load code from `lib`?
-[ ] GitHub Pages! Architect or Hacker template

data/lib/clerq/interactors.rb

@@ -1,5 +0,0 @@
-require_relative "interactors/create_node"
-require_relative "interactors/query_template"
-require_relative "interactors/query_assembly"
-require_relative "interactors/check_assembly"
-require_relative "interactors/render_assembly"

data/lib/clerq/interactors/check_assembly.rb

@@ -1,77 +0,0 @@
-# encoding: UTF-8
-
-require_relative "interactor"
-
-module Clerq
-  module Interactors
-
-    class CheckAssembly < Interactor
-
-      def call
-        @node = Clerq.node_repository.assemble
-        {}.tap do |errors|
-          nonuniq = nonuniq_ids
-          errors.merge!(nonuniq_ids: nonuniq) if !nonuniq.empty?
-          parents = unknown_parents
-          errors.merge!(unknown_parents: parents) if !parents.empty?
-          references = unknown_references
-          errors.merge!(unknown_references: references) if !references.empty?
-          order = unknown_order_index
-          errors.merge!(unknown_order_index: order) if !order.empty?
-        end
-      end
-
-      protected
-
-      # @return [Hash<node id, Array<file_name>>] node ids and array of file_names
-      def nonuniq_ids
-        @node.each_with_object({}){|node, hsh|
-          hsh[node.id] ||= []
-          # TODO that way CheckNodes depends on files!?
-          hsh[node.id] << node[:file_name]
-        }.select{|k, v| v.size > 1}
-        .each{|k, v| v.uniq!}
-      end
-
-      # @return [Hash<parent, Array<node id>>] unknown meta[:parent] and
-      #   array of nodes those have this meta attribute
-      def unknown_parents
-        @node # .drop(1)?
-        .select{|node| node[:parent] && node.parent.id != node[:parent]}
-        .each_with_object({}){|node, hsh|
-          hsh[node[:parent]] ||= []
-          hsh[node[:parent]] << node.id
-        }
-      end
-
-      # @return [Hash<node_id, Array<node_id>>] node ids that noe found
-      #   in hierarchy and array of node ids those have links to corresponding
-      #   unknown node
-      def unknown_references
-        index = @node.map(&:id).drop(1)
-        @node.each_with_object({}) do |node, hsh|
-          node.links
-          .reject {|lnk| index.include?(lnk)}
-          .each do |lnk|
-            hsh[lnk] ||= []
-            hsh[lnk] << node.id
-          end
-        end
-      end
-
-      # @return [Hash<node_id, Array<node_id>>] node ids and array of
-      #   unknown links in :order_index
-      def unknown_order_index
-        @node
-        .select{|node| node[:order_index]}
-        .each_with_object({}){|node, hsh|
-          order = node[:order_index].split(/ /)
-          wrong = order.select{|o| node.item(o).nil?}
-          hsh[node.id] = wrong unless wrong.empty?
-        }
-      end
-
-    end
-
-  end
-end

data/lib/clerq/interactors/interactor.rb

@@ -1,26 +0,0 @@
-# encoding: UTF-8
-
-module Clerq
-  module Interactors
-
-    class Interactor
-      Failure = Class.new(StandardError)
-
-      def self.inherited(klass)
-        klass.const_set(:Failure, Class.new(klass::Failure))
-      end
-
-      def self.call(*args)
-        new(*args).call
-      end
-
-      # Should be implemented in subclasses
-      def call; end
-
-      # TODO Suppress ability to create new object
-      # private_class_method :new
-
-    end
-
-  end
-end

data/lib/clerq/render_erb.rb

@@ -1,33 +0,0 @@
-# encoding: UTF-8
-
-require 'erb'
-
-module Clerq
-
-  # Render @object trough ERB temlate
-  #
-  # Usage
-  #   erb = "id: <%= @object.id %>\ntitle: <%= @object.title %>\n"
-  #   obj = Node.new(id: 'uc', title: 'Use Cases', meta: {skip_meta: true})
-  #   txt = RenderErb.call(erb, obj) # or RenderErb.(erb, obj)
-  class RenderErb
-
-    # @param erb [Text] ERB template
-    # @param object [Object]
-    # @result [String?]
-    def self.call(erb: , object: )
-      new(erb: erb, object: object).call
-    end
-
-    def call
-      tt = ERB.new(@erb, nil, "-")
-      tt.result(binding)
-    end
-
-    def initialize(erb: , object: )
-      @erb = erb
-      @object = object
-    end
-  end
-
-end

data/lib/clerq/repositories/node_reader.rb

@@ -1,107 +0,0 @@
-# encoding: UTF-8
-
-require_relative '../entities'
-include Clerq::Entities
-
-module Clerq
-  module Repositories
-  end
-end
-
-class Clerq::Repositories::NodeReader
-
-  # @param [String] file_name with node
-  # @return [Array<Node>] from file
-  def self.call(file_name)
-    new(file_name).call
-  end
-
-  # @param [Enumerator] lines; for testing purpose
-  # @return [Array<Node>] from file
-  def call(text = File.foreach(@file_name))
-    STDOUT.print "Reading #{@file_name} ..."
-
-    read_nodes(text).each do |node_text|
-      level, node = parse_node(node_text)
-      next unless node
-      node[:file_name] = @file_name
-      insert_node(node, level)
-    end
-
-    STDOUT.puts @errors.empty? ? "OK" : "Errors found"
-    unless @errors.empty?
-      STDERR.puts "Errors reading #{@file_name}"
-      STDERR.puts @errors.map{|e| "\t#{e}"}.join("\n")
-    end
-
-    nodes = Array.new(@node.items)
-    nodes.each(&:orphan!)
-    nodes
-  end
-
-  protected
-
-    def initialize(file_name)
-      @file_name = file_name
-      @node = Node.new(id: file_name)
-      @errors = []
-    end
-
-    # @param [Enumerator<String>] text
-    # @return [Array<String>] where each item represents one node
-    def read_nodes(text)
-      [].tap do |nodes|
-        quote, body = false, ''
-        text.each do |line|
-          if line.start_with?('#') && !quote && !body.empty?
-            nodes << body
-            body = ''
-          end
-          body << line
-          quote = !quote if line.start_with?('```')
-        end
-        nodes << body unless body.empty?
-      end
-    end
-
-    def insert_node(node, level)
-      parent = @node
-      while parent.last_item && (parent.nesting_level + 1) < level
-        parent = parent.last_item
-      end
-      unless (parent.nesting_level + 1) == level
-        @errors << "invalid header level: #{'#' * level} [#{node.id}]"
-        parent = @node
-      end
-      parent << node
-    end
-
-    def parse_node(text)
-      text += "\n" unless text.end_with?("\n")
-      parts = NODE_REGX.match(text)
-      lv = parts[1] || ''
-      id = parts[3] || ''
-      title = parts[4] || ''
-      body = parts[7] || ''
-      meta = {}
-      meta.merge!(parse_meta(parts[6])) if parts[6]
-      [lv.size, Node.new(id: id, title: title, body: body.strip, meta: meta)]
-    rescue StandardError
-      @errors << "invalid node format:\n#{text}"
-      [nil, nil]
-    end
-
-    def parse_meta(text)
-      text.strip.split(/[;\n]/).inject({}) do |h, i|
-        pair = /\s?(\w*):\s*(.*)/.match(i)
-        h.merge(pair[1].to_sym => pair[2])
-      end || {}
-    rescue StandardError
-      @errors << "invalid meta format:\n{{#{text}}}"
-      {}
-    end
-
-    NODE_REGX =
-      /^(\#+)[ ]*(\[([^\[\]\s]*)\][ ]*)?([\s\S]*?)\n({{([\s\S]*?)}})?(.*)$/m
-
-end