clerq 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65f2b9b019f3810c02e66f1ed3eba1d6b706ad8a63be53c2ff55a88665816941
-  data.tar.gz: 74a5363279f3487897c342a31f134b9f9051bdfac4f62fbe73b4239ec00f09d9
+  metadata.gz: 1b93dbd123950517f23f59aaf416dd20291df8a81bad903f7267ab070fe789fe
+  data.tar.gz: f029392d1e4cc1697d8eeb597cee32ed6b28dc50a56586c6d2f9dc0dadef7b67
 SHA512:
-  metadata.gz: 1652c52a62a58dc18e58b7aae6f9f622d4e602811020bf91a04f3009cc2cfe055d372fe200ac746b2c2c4691c7a9c6e3b3f91c1a5f0586d08acaaa596e53c7e6
-  data.tar.gz: e55c6afa867a5d193b033fb53e009026f4200cb10d3d4bedf8d47a266a360bd6cb729298fd05520fc3224a92456b1c822aa6b8bca2c2012125f2c3d96ac66636
+  metadata.gz: e14bdc8e40f10e25035546a4c460d997305d667974e03ef3fe221115bb597fa4ca690d6879a252f8bed972bda741079d2d4ac20510ac40bf14c509f1f480d35e
+  data.tar.gz: bda6247460cab6cb6c0a65aa6b954647f88542a264f872c7df9dbcc26d0242c8bfb0cce2ad1f37a5da20d2d94b5ed8451d360aca0a8274075b8324ae238d7e0c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## 0.3.1 (2019-12-13)
+
+* Fixed error with reading files that read attributes to body.
+* Added `mm` command to `<project>.thor` that creates "Meeting Minutes" files in `<project>/mm` folder. 
+
 ## 0.3.0 (2019-12-04)
 
 * Meet services instead of interactors. All interactors removed and their responsibility moved to appropriate services.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clerq (0.3.0)
+    clerq (0.3.1)
       thor (~> 0.20.3)
 
 GEM

data/lib/assets/knb/requirement-classification.md

@@ -0,0 +1,27 @@
+% Requirements classification
+
+BABOK
+
+__Business requirements__: statements of goals, objectives, and outcomes that describe why a change has been initiated. They can apply to the whole of an enterprise, a business area, or a specific initiative.
+
+__Stakeholder requirements__: describe the needs of stakeholders that must be met in order to achieve the business requirements. They may serve as a bridge between business and solution requirements
+
+__Solution requirements__ : describe the capabilities and qualities of a solution that meets the stakeholder requirements. They provide the appropriate level of detail to allow for the development and implementation of the solution. Solution requirements can be divided into two sub-categories:
+
+* __functional requirements__: describe the capabilities that a solution must have in terms of the behaviour and information that the solution will manage, and
+* __non-functional requirements or quality of service requirements__: do not relate directly to the behaviour of functionality of the solution, but rather describe conditions under which a solution must remain effective or qualities that a solution must have.
+
+__Transition requirements__: describe the capabilities that the solution must have and the conditions the solution must meet to facilitate transition from the current state to the future state, but which are not needed once the change is complete. They are differentiated from other requirements types because they are of a temporary nature. Transition requirements address topics such as data conversion, training, and business continuity.
+
+Stakeholders
+
+Each task includes a list of stakeholders who are likely to participate in the execution of that task or who will be affected by it. A stakeholder is an individual or group that a business analyst is likely to interact with directly or indirectly. Any stakeholder can be a source of requirements, assumptions, or
+constraints.
+
+SMART
+
+* Specific: describing something that has an observable outcome,
+* Measurable: tracking and measuring the outcome,
+* Achievable: testing the feasibility of the effort,
+* Relevant: aligning with the enterprise’s vision, mission, and goals, and
+* Time-bounded: defining a time frame that is consistent with the need

data/lib/assets/knb/requirement-quality.md

@@ -0,0 +1,13 @@
+% Characteristics of Requirements and Designs Quality
+
+While quality is ultimately determined by the needs of the stakeholders who will use the requirements or the designs, acceptable quality requirements exhibit many of the following characteristics:
+
+* __Atomic__: self-contained and capable of being understood independently of other requirements or designs.
+* __Complete__: enough to guide further work and at the appropriate level of detail for work to continue. The level of completeness required differs based on perspective or methodology, as well as the point in the life cycle where the requirement is being examined or represented.
+* __Consistent__: aligned with the identified needs of the stakeholders and not conflicting with other requirements.
+* __Concise__: contains no extraneous and unnecessary content.
+* __Feasible__: reasonable and possible within the agreed-upon risk, schedule, and budget, or considered feasible enough to investigate further through experiments or prototypes.
+* __Unambiguous__: the requirement must be clearly stated in such a way to make it clear whether a solution does or does not meet the associated need.
+* __Testable__: able to verify that the requirement or design has been fulfilled. Acceptable levels of verifying fulfillment depend on the level of abstraction of the requirement or design.
+* __Prioritized__: ranked, grouped, or negotiated in terms of importance and value against all other requirements.
+* __Understandable__: represented using common terminology of the audience.

data/lib/assets/new/clerq.thor.tt

@@ -6,8 +6,37 @@ class <%=config[:klass]%> < Thor
 
   desc "stat", "Print statistic"
   def stat
-    nodes = Clerq::Interactors::JoinNodes.()
+    nodes = Clerq.assemble
     say "#{nodes.to_a.drop(1).size} nodes total"
   end
 
+  desc "mm", "Create meeting minutes"
+  def mm
+    minutes = "meeting minutes #{Time.new.strftime('%Y-%m-%d')}.md"
+    content = "% #{minutes.capitalize}\n\n" + MINUTES_TEMPLATE
+    Dir.mkdir('mm') unless Dir.exist?('mm')
+    File.write("mm/#{minutes}", content)
+    say "'mm/#{minutes}' created!"
+  end
+
+  MINUTES_TEMPLATE = <<~EOF
+    # Attendants
+
+    1.
+    2.
+    3.
+
+    # Questions
+
+    1.
+    2.
+    3.
+
+    # Resolutions
+
+    1.
+    2.
+    3.
+  EOF
+
 end

data/lib/clerq/services/read_node.rb

@@ -11,7 +11,9 @@ module Clerq
     class ReadNode < Service
 
       def call
-        text = File.foreach(@filename)
+        # 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
@@ -38,6 +40,7 @@ module Clerq
       # @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"))

data/lib/clerq/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clerq
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Nikolay Voynov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-04 00:00:00.000000000 Z
+date: 2019-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,7 +97,9 @@ files:
 - 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