clerq 0.1.0 → 0.3.3

data/lib/clerq/services/query_node.rb

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+
+require_relative "service"
+
+module Clerq
+  module Services
+
+    # Provides repository nodes assembly
+    # @param [Sring] optional query string
+    # @return [Node] assembly of repository nodes
+    #
+    # Usage
+    #   QueryAssembly.(asse:, query:)
+    #   QueryAssembly.(query_string)
+    #
+    # Rules for root node:
+    #   when query not passed, it return the whole hierarchy
+    #   when nodes not found, it returns empty root node with meta[:query]
+    #   when query returns one single node, it returns this node
+    #   when query returns mare than one nodes, then
+    #     * it creates empty root node with meta[:query]
+    #     * and places found nodes to the root
+    class QueryNode < Service
+
+      def call
+        proc = prepare_query unless @query.empty?
+
+        arry = @assembly.select{|node| proc.call(node) }
+        return arry.first.orphan! if arry.size == 1
+
+        node = Node.new(title: Clerq.title, meta: {query: @query})
+        arry.each{|n| node << n.orphan!}
+        node
+      end
+
+      protected
+
+      def initialize(assembly: , query: )
+        unless assembly.is_a? Node
+          msg = "Invailid argument 'assembly'"
+          raise ArgumentError, msg
+        end
+        unless query.is_a? String
+          msg = "Invailid argument 'query'"
+          raise ArgumentError, msg
+        end
+        @query = query
+        @assembly = assembly
+      end
+
+      def prepare_query
+        proc = Proc.new{|node| eval(@query)}
+        Node.new.select{|node| proc.call(node)}
+        proc
+      rescue Exception => e
+        msg = "Invalid query format #{@query} (#{e.message})\n#{USAGE}"
+        raise ArgumentError, msg
+      end
+
+      USAGE = <<~EOF
+        QueryAssembly.call(query: ) evaluates query paramater
+        by eval() as 'Proc.new { |node| eval(query) }'
+        e.g. the followed queries are valid:
+          node.id == 'uc'
+          node.title == 'Introduction'
+          node[:originator] == 'clerq'
+      EOF
+
+    end
+
+  end
+end

data/lib/clerq/services/query_template.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+require_relative "service"
+
+module Clerq
+  module Services
+
+    class QueryTemplate < Service
+
+      def call
+        Clerq.text_repository.text(@template)
+      end
+
+      # @param template [String] required name of template
+      def initialize(template)
+        if !(template.is_a?(String) && !template.empty?)
+          msg = "Invailid argument 'template'"
+          raise ArgumentError, msg
+        end
+        @template = template
+      end
+
+    end
+
+  end
+end

data/lib/clerq/services/read_node.rb

@@ -0,0 +1,101 @@
+# encoding: UTF-8
+require_relative 'service'
+require_relative '../entities/node'
+include Clerq::Entities
+
+module Clerq
+  module Services
+
+    # The service reads nodes from file and returns array of nodes
+    # It returns array because the file can have a few root nodes
+    class ReadNode < Service
+
+      def call
+        # FIXME: something wrong here when foreach!
+        #
+        text = File.read(@filename)
+        read_nodes(text) do |node_text|
+          level, node = parse_node(node_text)
+          next unless node
+          node[:filename] = @filename
+          insert_node(node, level)
+        end
+
+        ary = Array.new(@node.items)
+        ary.each(&:orphan!)
+        ary
+      end
+
+      # @param filename [String] input file for reading
+      # @param on_error [Proc] proc object {|error| ...}
+      def initialize(filename, on_error = nil)
+        @filename = filename
+        @on_error = on_error
+        @node = Node.new(id: filename)
+      end
+
+      protected
+
+      # @param [Enumerator<String>] text
+      # @return [Array<String>] where each item represents one node
+      def read_nodes(text, &block)
+        quote, node = false, []
+        text = text.split(?\n) unless text.is_a? Enumerator
+        text.each do |line|
+          if line.start_with?('#') && !quote && !node.empty?
+            block.call(node.join("\n"))
+            node = []
+          end
+          node << line
+          quote = !quote if line.start_with?('```')
+        end
+        block.call(node.join("\n")) unless node.empty?
+      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
+          msg = "invalid header level: #{'#' * level} #{node.title}"
+          @on_error.call(msg) if @on_error
+          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
+        msg = "invalid node format: #{text}"
+        @on_error.call(msg) if @on_error
+        [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
+        msg = "invalid meta format:\n{{#{text}}}"
+        @on_error.call(msg) if @on_error
+        {}
+      end
+
+      NODE_REGX =
+        /^(\#+)[ ]*(\[([^\[\]\s]*)\][ ]*)?([\s\S]*?)\n({{([\s\S]*?)}})?(.*)$/m
+
+    end
+
+  end
+end

data/lib/clerq/services/render_erb.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+require 'erb'
+require_relative 'service'
+
+module Clerq
+  module Services
+
+    # 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 < Service
+
+      def call
+        tt = ERB.new(@erb, nil, "-")
+        tt.result(binding)
+      end
+
+      def initialize(erb: , object: )
+        @erb = erb
+        @object = object
+      end
+    end
+
+  end
+end

data/lib/clerq/services/render_node.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+require_relative 'service'
+require_relative 'query_template'
+require_relative 'render_erb'
+
+module Clerq
+  module Services
+
+    class RenderNode < Service
+
+      def call
+        @erb = QueryTemplate.(@ett)
+        RenderErb.(erb: @erb, object: @node)
+      end
+
+      def initialize(node: , template:)
+        check_string_argument!(template, 'template')
+        check_string_empty!(template, 'template')
+        @node = node
+        @ett = template
+      end
+
+      def check_string_argument!(arg, str)
+        return if arg.is_a? String
+        errmsg = ":#{str} must be String!"
+        raise ArgumentError, errmsg, caller
+      end
+
+      def check_string_empty!(arg, str)
+        return unless arg.empty?
+        errmsg = ":#{str} cannot be empty!"
+        raise ArgumentError, errmsg, caller
+      end
+    end
+
+  end
+end

data/lib/clerq/services/service.rb

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

data/lib/clerq/settings.rb

@@ -12,9 +12,9 @@ module Clerq
     STORAGE = 'clerq.yml'.freeze
 
     # binary document settings that can be changed through 'clerq.yml'
-    property :document, default: 'Clеrk SRS'
+    property :document, default: 'Clеrq SRS'
     property :template, default: 'default.md.erb'
-    property :title, default: 'Clеrk SRS'
+    property :title, default: 'Clеrq SRS'
 
     # folders structure
     property :bin, default: 'bin'

data/lib/clerq/version.rb

@@ -1,3 +1,3 @@
 module Clerq
-  VERSION = "0.1.0"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clerq
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Nikolay Voynov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,58 +16,59 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.14.2
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.3
-description: The gem provides requirements markup; file based requirements project
-  structure; document templates; customizable CLI for managing requirements projects.
+        version: 1.0.1
+description: The gem provides text nodes markup, text repository, advanced customizable
+  CLI for managing repository, the powerful templating system for text transformation
+  that perfect matches for managing large structured texts.
 email:
 - nvoynov@gmail.com
 executables:
@@ -77,15 +78,33 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - 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-classification.md
+- lib/assets/knb/requirement-life-cycle.md
+- lib/assets/knb/requirement-quality.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
@@ -113,34 +132,27 @@ files:
 - lib/assets/promo/src/us/us.reader.md
 - lib/assets/promo/src/us/us.writer.md
 - lib/assets/tt/default.md.erb
-- lib/assets/tt/gitlab.md.erb
 - lib/assets/tt/pandoc.md.erb
-- lib/assets/tt/raw.md.erb
 - lib/clerq.rb
 - lib/clerq/cli.rb
 - lib/clerq/entities.rb
 - lib/clerq/entities/node.rb
-- lib/clerq/entities/template.rb
-- lib/clerq/gateways.rb
-- lib/clerq/gateways/gateway.rb
-- lib/clerq/gateways/in_files.rb
-- lib/clerq/gateways/in_memory.rb
-- lib/clerq/interactors.rb
-- lib/clerq/interactors/check_nodes.rb
-- lib/clerq/interactors/compile_nodes.rb
-- lib/clerq/interactors/create_node.rb
-- lib/clerq/interactors/interactor.rb
-- lib/clerq/interactors/join_nodes.rb
-- lib/clerq/interactors/query_nodes.rb
 - lib/clerq/properties.rb
 - lib/clerq/repositories.rb
-- lib/clerq/repositories/in_memory.rb
-- lib/clerq/repositories/node_reader.rb
+- lib/clerq/repositories/file_repository.rb
 - lib/clerq/repositories/node_repository.rb
-- lib/clerq/repositories/repository.rb
-- lib/clerq/repositories/template_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/templater.rb
 - lib/clerq/version.rb
 homepage: https://github.com/nvoynov/clerq
 licenses:
@@ -150,7 +162,7 @@ metadata:
   homepage_uri: https://github.com/nvoynov/clerq
   source_code_uri: https://github.com/nvoynov/clerq
   changelog_uri: https://github.com/nvoynov/clerq/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,8 +177,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
-summary: Toolkit for requirements management
+summary: Text node repository and automation of managing large structured texts.
 test_files: []