ll 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a9c96ac0bda2425338cd0312cc63c2f731332853ad6d9f5e8043e281fedafd0
-  data.tar.gz: af61f5a74e8939b56479c24e6cb2f126e02c0615a67831941d80462a16cfe4ac
+  metadata.gz: 88c6d3677c49c8b6f9977add7a3716bedaae5d2b9b802cc695bdb84312b2069e
+  data.tar.gz: 30b346cce42bce4ad8a63f441be831abb838363ad4ddf9b001cd2f91d1090295
 SHA512:
-  metadata.gz: '0030849c4e589aebd29b086d1a39b03c0258e0bbebaed789f96222a3b6314ca7f51f0591452b552c9640e278c021ed7ad871e5bff011052f6889c7c540d32e1d'
-  data.tar.gz: 1006dab7dee8774be6d1cd1ff93585d7b1483d0dc9ae81f3012bc3ee1cfdc6db261a650b453bae1dba23cb0e8358cb4aac01157b8c676eee565a2fed30ecc72a
+  metadata.gz: 85b41f41dcd5e55cfa489302082d8ebe075f6e46a9e29c42dd17f5627a2350783efea37cdb91313ccbef41bb6c226c59e164deeb0d905a0c6c07e2951d79d4bf
+  data.tar.gz: e17e043551d74fe86613b18077a5b89c3ef43a4ec7b39def328c6d886cadd9c090bc05580ab585759b09294666a9890fa1581c8941a8e2793970fb536dcca9c1

data/lib/ll.rb

@@ -2,3 +2,12 @@ require "pry"
 require "vv"
 
 Gem.require_files "ll/*.rb"
+
+module LL
+
+  def default_authority
+    "github.com/zachaysan/ll"
+  end
+  module_function :default_authority
+
+end

data/lib/ll/checklist.rb

@@ -1,6 +1,14 @@
 class LL::Checklist
 
-  attr_reader :name
+  attr_reader :name,
+              :authority,
+              :title,
+              :description,
+              :identifier,
+              :action_at,
+              :steps,
+              :document_version,
+              :serialization_identifier
 
   def self.load( dir: )
     filepaths = Dir.glob(File.join dir, "checklists/*")
@@ -9,14 +17,111 @@ class LL::Checklist
     end
   end
 
-  def initialize json_document=nil, name: nil
-    # TODO: Parse the document
+  # Maybe abstract the versioning here into VV?
+  def initialize document: nil,
+                 name: nil,
+                 authority: nil
     @name   = name
     @name ||= "Prototypical"
+
+    @authority   = authority
+    @authority ||= LL.default_authority
+
+    @document_version = nil
+
+    self.parse_document! document if document
+
+    yield self if block_given?
+
+    self.reformat! unless self.document_current?
+  end
+
+  def reformat!
+    @document_version = self.current_version
+
+    # Because the same checklist may be serialized multiple times,
+    # by different clients it will get tricky tracing problems, so
+    # we include an identifier that clients should generate, but never
+    # manipulate.
+    @serialization_identifier = Random.identifier
+
+    self.steps
+  end
+
+  def document_current?
+    return nil if @document_version.nil?
+
+    @document_version == self.current_version
+  end
+
+  def parse_document! document
+    if document.is_a? String
+      document = document.parse_json
+    elsif document.is_a? Hash
+    else
+      fail TypeError, "Checklist expects string or hash document"
+    end
+
+    document.symbolize_keys!
+
+    attrs = %i[ meta
+                title
+                description
+                identifier
+                serialization_identifier
+                action_at
+                steps ]
+
+    self.set_attrs_via attrs, document: document
+  end
+
+  def current_version
+    LL::VERSION
+  end
+
+  def supported_versions
+    %w[ 0.0.2
+        0.0.3 ]
   end
 
-  def parse_document json_document
-    raise NotImplementedError
+  def kind
+    "checklist"
+  end
+
+  def meta= meta
+    meta.symbolize_keys!
+    meta_authority = meta.fetch :authority
+    meta_version   = meta.fetch :version
+    meta_kind      = meta.fetch :kind
+    meta_format    = meta.fetch :format
+
+    authority_ok = meta_authority == self.authority
+    message = "Document authority `#{meta_authority}` unknown."
+    fail message unless authority_ok
+
+    format_ok = meta_format == "json"
+    message = \
+    "Document format `#{meta_format}` not supported, must be `json`."
+    fail message unless format_ok
+
+    version_ok = meta_version.one_of?( *supported_versions )
+    message = "Document version `#{meta_version}` not supported."
+    fail message unless version_ok
+
+    kind_ok = meta_kind == "checklist"
+    message = \
+    "Document kind `#{meta_kind}` not supported, must be `checklist`."
+    fail message unless kind_ok
+
+    @document_version = meta_version
+  end
+
+  def steps= steps
+    fail "Expecting steps to be an array." unless steps.is_a? Array
+    @steps = steps.map do |step|
+      fail "Expecting step to be a hash." unless step.is_a? Hash
+      LL::Step.new step, document_version: @document_version
+    end
   end
 
   def to_s
@@ -24,11 +129,30 @@ class LL::Checklist
   end
 
   def to_h
-    { name: self.name }
+    message = \
+    "Checklist in indeterminate state. This should never happen."
+    fail message unless self.document_current?
+
+    format = "hash"
+    meta = { version: self.current_version,
+             kind: self.kind,
+             authority: self.authority,
+             format: format }
+
+    { meta: meta,
+      title: self.title,
+      description: self.description,
+      identifier: self.identifier,
+      serialization_identifier: self.serialization_identifier,
+      action_at: self.action_at,
+      steps: self.steps }
   end
 
-  def to_json
-    JSON.dump self.to_hash
+  def vv_json
+    format = "json"
+    response = self.to_h
+    response[:meta][:format] = format
+    response.vv_json
   end
 
 end

data/lib/ll/step.rb

@@ -12,10 +12,12 @@ class LL::Step
               :action_at,
               :version
 
-  def initialize json_document
+  def initialize json_document, document_version:
     # TODO: Auto convert dasherized to underscore
     data = json_document.to_h.symbolize_keys
 
+    @document_version = document_version || LL::VERSION
+
     @title       = data[:title]
     @description = data[:description]
     @action      = data[:action]
@@ -27,7 +29,6 @@ class LL::Step
     @via         = data[:via]
     @os          = data[:via]
     @with        = data[:via]
-    @doc_version = data[:doc_version]
     @action_at   = data[:action_at]
   end
 
@@ -36,4 +37,20 @@ class LL::Step
     raise NotImplementedError
   end
 
+  def to_h
+    { title: title,
+      description: description,
+      action: action,
+      kind: kind,
+      status: status,
+      identifier: identifier,
+      by: by,
+      via: via,
+      action_at: action_at }
+  end
+
+  def vv_json
+    self.to_h.vv_json
+  end
+
 end

data/lib/ll/version.rb

@@ -1,3 +1,21 @@
 module LL
-  VERSION = '0.0.3'
+
+  VERSION = '0.0.4'
+  Version = VERSION
+
+  def version
+    LL::VERSION
+  end
+  module_function :version
+
+  def Version
+    LL::VERSION
+  end
+  module_function :Version
+
+  def VERSION
+    LL::VERSION
+  end
+  module_function :VERSION
+
 end

data/test/fixtures/checklists/v0.0.2.json

@@ -1,10 +1,13 @@
-{"title": "Gem Tasks",
+{"meta": { "authority": "github.com/zachaysan/ll",
+           "kind": "checklist",
+           "format": "json",
+           "version": "0.0.2" },
+ "title": "Gem Tasks",
  "description": "Finicky gem build details",
  "action": "create",
- "kind": "checklist",
  "identifier": "vux25anby00000000000000000",
+ "serialization_identifier": "zcte2zaw23xkyvcbpz2vc94i9qbi3xnkgtfxzvld",
  "action_at": "2019-02-21T19:42:06Z",
- "format": "json-v0.0.2",
  "steps": [ { "title": "Bump version",
               "description": null,
               "action": "create",

data/test/test_checklist.rb

@@ -9,4 +9,72 @@ class ChecklistTest < Minitest::Test
     assert_equal expected_string, checklist.to_s
   end
 
+  def test_current_version_is_supported
+    checklist = LL::Checklist.new
+    assert_includes checklist.supported_versions,
+                    checklist.current_version
+  end
+
+  def test_loads_latest_checklist
+    fixture = LL::Fixtures.previous_checklist
+
+    former_serialization_identifier = serialization_identifier = \
+    "zcte2zaw23xkyvcbpz2vc94i9qbi3xnkgtfxzvld"
+
+    checklist = LL::Checklist.new document: fixture do | checklist |
+      refute checklist.document_current?
+      expected_version = "0.0.2"
+      assert_equal expected_version, checklist.document_version
+      assert_equal serialization_identifier,
+                   checklist.serialization_identifier
+    end
+
+    expected_version = LL::VERSION
+    assert_equal expected_version, checklist.document_version
+
+    json = checklist.vv_json
+    parsed_json = JSON.parse json
+
+
+    expected_authority = "github.com/zachaysan/ll"
+    expected_kind      = "checklist"
+    expected_format    = "json"
+    expected_version   = LL::VERSION
+
+    assert_includes parsed_json, "meta"
+    meta = parsed_json["meta"]
+
+    assert_equal expected_authority, meta["authority"]
+    assert_equal expected_kind,      meta["kind"]
+    assert_equal expected_format,    meta["format"]
+    assert_equal expected_version,   meta["version"]
+
+    expected_title       = "Gem Tasks"
+    expected_description = "Finicky gem build details"
+    expected_identifier  = "vux25anby00000000000000000"
+    expected_action_at   = "2019-02-21T19:42:06Z"
+
+    assert_equal expected_title,       parsed_json["title"]
+    assert_equal expected_description, parsed_json["description"]
+    assert_equal expected_identifier,  parsed_json["identifier"]
+    assert_equal expected_action_at,   parsed_json["action_at"]
+
+    refute_equal former_serialization_identifier,
+                 parsed_json["serialization_identifier"]
+
+    assert_includes parsed_json, "steps"
+    steps = parsed_json["steps"]
+
+    expected_count = 3
+    assert_equal expected_count, steps.count
+
+    expected_title = "Bump version"
+    assert_equal expected_title, steps.first["title"]
+
+    expected_title = "Tweet about upcoming release"
+    assert_equal expected_title, steps.second["title"]
+
+    assert_nil steps.third["title"]
+  end
+
 end

data/test/test_helper.rb

@@ -5,3 +5,23 @@ begin
   require "pry"
 rescue LoadError
 end
+
+class LL::Fixtures
+
+  def self.read_checklist version
+    File.read File.join("test", "fixtures", "checklists", version)
+  end
+
+  # Keep these staggered
+  def self.checklist
+    self.read_checklist "v0.0.2.json"
+  end
+  def self.previous_checklist
+    self.read_checklist "v0.0.2.json"
+  end
+
+  def self.latest_checklist
+    self.checklist
+  end
+
+end

data/test/test_ll.rb

@@ -14,4 +14,15 @@ class LLTest < Minitest::Test
     assert String.vv_included?
   end
 
+  def test_version
+    refute_nil LL::VERSION
+
+    assert_equal LL::VERSION, LL::Version
+    assert_equal LL::VERSION, LL::version
+
+    assert_equal LL::VERSION, LL.VERSION
+    assert_equal LL::VERSION, LL.Version
+    assert_equal LL::VERSION, LL.version
+  end
+
 end

data/test/test_step.rb

@@ -17,7 +17,7 @@ class StepTest < Minitest::Test
       "doc_version": "0.0.2",
       "action_at": "2019-02-21T19:41:06Z"}.to_json
 
-    step = LL::Step.new step_input
+    step = LL::Step.new step_input, document_version: nil
     expected_status = "boot"
     assert_equal expected_status, step.status
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ll
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Zach Aysan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-05 00:00:00.000000000 Z
+date: 2019-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vv
@@ -106,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Listy List