adalog 0.4.0

data/test/unit/configuration_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+
+class ConfigurationTest < Minitest::Test
+
+  class MockRepo
+    def recorded_calls
+      @recorded_calls ||= []
+    end
+
+    def method_missing(msg, *args, &block)
+      recorded_calls << msg
+      msg
+    end
+
+    def called?(msg)
+      recorded_calls.include?(msg)
+    end
+  end
+
+
+################################################################################
+
+
+  test "can be configured via namespace configure method" do
+    repo = MockRepo.new
+    Adalog.configure do |config|
+      config.repo         = repo
+      config.singleton    = false
+      config.html_erb     = true
+      config.web_heading  = "Captain what's our heading?"
+      config.time_format  = "%Y-%m-%d %H:%M:%S"
+    end
+
+    assert_equal(repo, Adalog.configuration.repo)
+    assert_equal(false, Adalog.configuration.singleton)
+    assert_equal(true,  Adalog.configuration.html_erb)
+    assert_equal("Captain what's our heading?", Adalog.configuration.web_heading)
+    assert_equal("%Y-%m-%d %H:%M:%S", Adalog.configuration.time_format)
+  end
+
+
+  test "repo can be accessed via namespace when singleton is true" do
+    repo = MockRepo.new
+    Adalog.configure do |config|
+      config.repo         = repo
+      config.singleton    = true
+      config.html_erb     = true
+      config.web_heading  = "Captain what's our heading?"
+      config.time_format  = "%Y-%m-%d %H:%M:%S"
+    end
+    Adalog.fetch
+    repo.called?(:fetch)
+    Adalog.insert
+    repo.called?(:insert)
+    Adalog.all
+    repo.called?(:all)
+    Adalog.clear!
+    repo.called?(:clear!)
+  end
+
+
+end

data/test/unit/entry_test.rb

@@ -0,0 +1,138 @@
+require 'test_helper'
+
+class EntryTest < Minitest::Test
+
+  ##
+  # So we can be lazy and omit typing the namspace fifty times.
+  Entry = Adalog::Entry
+
+
+  AnotherEntryClass = Struct.new(:title, :timestamp, :message, :details, :format)
+
+
+  class AnotherEntryClassWithToH
+    attr_reader :to_h_was_used
+
+    def initialize(timestamp)
+      @timestamp      = timestamp
+      @to_h_was_used  = false
+    end
+
+    def to_h
+      @to_h_was_used = true
+      { title:      "Something",
+        timestamp:  @timestamp,
+        message:    "happened",
+        format:     "plain",
+        details:    "in the world"
+      }
+    end
+  end
+
+
+################################################################################
+
+
+  test "is invalid when none of title, message or details are set" do
+    entry = Entry.new
+    refute(entry.valid?)
+    assert(entry.errors.any?)
+  end
+
+
+  test "will provide the current timestamp if no timestamp is given" do
+    before_new  = Time.now
+    entry       = Entry.new
+    after_new   = Time.now
+    assert(before_new <= entry.timestamp)
+    assert(entry.timestamp <= after_new)
+  end
+
+
+  test "is valid with at least one of title, message or details" do
+    entry = Entry.new(title: "GroupRaise Schedule Adapter")
+    assert(entry.valid?)
+    entry = Entry.new(message: "meal:requested")
+    assert(entry.valid?)
+    entry = Entry.new(details: "EMERGE Fellowship at Berry Hill")
+    assert(entry.valid?)
+  end
+
+
+  test "can be built from another object of the same interface" do
+    another_obj = AnotherEntryClass.new("Something", Time.now, "happened", "in the world")
+    entry       = Entry.build(another_obj)
+    assert(entry.valid?)
+    assert_equal(another_obj.title,     entry.title)
+    assert_equal(another_obj.timestamp, entry.timestamp)
+    assert_equal(another_obj.message,   entry.message)
+    assert_equal(another_obj.details,   entry.details)
+  end
+
+
+  test "is invalid when built from an object missing the required methods" do
+    entry = Entry.build(Object.new)
+    refute(entry.valid?)
+  end
+
+
+  test "can be built from a hash-like object" do
+    hash  = {
+      title:      "Something",
+      timestamp:  Time.now,
+      message:    "happened",
+      details:    "in the world"
+    }
+    entry = Entry.build(hash)
+    assert(entry.valid?)
+    assert_equal(hash[:title],      entry.title)
+    assert_equal(hash[:timestamp],  entry.timestamp)
+    assert_equal(hash[:message],    entry.message)
+    assert_equal(hash[:details],    entry.details)
+  end
+
+
+  test "can be built from a hash-like object with string keys" do
+    hash  = {
+      'title'     => "Something",
+      'timestamp' => Time.now,
+      'message'   => "happened",
+      'details'   => "in the world"
+    }
+    entry = Entry.build(hash)
+    assert(entry.valid?)
+    assert_equal(hash['title'],     entry.title)
+    assert_equal(hash['timestamp'], entry.timestamp)
+    assert_equal(hash['message'],   entry.message)
+    assert_equal(hash['details'],   entry.details)
+  end
+
+
+  test "can be built from an object responding to to_h" do
+    now   = Time.now
+    other = AnotherEntryClassWithToH.new(now)
+    entry = Entry.build(other)
+    assert(other.to_h_was_used)
+    assert(entry.valid?)
+    assert_equal("Something",     entry.title)
+    assert_equal(now,             entry.timestamp)
+    assert_equal("happened",      entry.message)
+    assert_equal("in the world",  entry.details)
+  end
+
+
+  test "can be built from distinct keyword arguments" do
+    now   = Time.now
+    entry = Entry.new(
+      timestamp:  now,
+      title:      "Something",
+      message:    "happened",
+      details:    "in the world")
+    assert(entry.valid?)
+    assert_equal("Something",     entry.title)
+    assert_equal(now,             entry.timestamp)
+    assert_equal("happened",      entry.message)
+    assert_equal("in the world",  entry.details)
+  end
+
+end

data/test/unit/in_memory_repo_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class InMemoryRepoTest < Minitest::Test
+
+  test "" do
+    skip
+  end
+
+end

data/test/unit/pstore_repo_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class PStoreRepoTest < Minitest::Test
+
+  test "" do
+    skip
+  end
+
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: adalog
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Paul Kwiatkowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: turn-again-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: A not-quite logger, with several storage methods. Records occurrences,
+  provides a web app for viewing entries. Motivated by the need to record the actions
+  of stubbed-out versions of adapters to third-party services, and for that record
+  to be something other than a traditional logger. Web viewer is built in Sinatra
+  and so can be run standalone via the usual methods or mounted at some route within
+  a Rails app. Comes with three repository implementations for storing/retrieving
+  entries and is trivial to write your own.
+email:
+- paul@groupraise.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- adalog.gemspec
+- lib/adalog.rb
+- lib/adalog/active_record_repo.rb
+- lib/adalog/configuration.rb
+- lib/adalog/entry.rb
+- lib/adalog/in_memory_repo.rb
+- lib/adalog/pstore_repo.rb
+- lib/adalog/simple_logging_adapter.rb
+- lib/adalog/version.rb
+- lib/adalog/web.rb
+- lib/adalog/web/public/javascripts/adalog.js
+- lib/adalog/web/public/javascripts/entries-list.js
+- lib/adalog/web/public/javascripts/vanilla-js.js
+- lib/adalog/web/public/stylesheets/adalog.css
+- lib/adalog/web/public/stylesheets/entries-list.css
+- lib/adalog/web/public/stylesheets/pure/buttons-min.css
+- lib/adalog/web/public/stylesheets/pure/forms-min.css
+- lib/adalog/web/public/stylesheets/pure/menus-min.css
+- lib/adalog/web/public/stylesheets/pure/pure-base-min.css
+- lib/adalog/web/public/stylesheets/pure/pure-grids-responsive-min.css
+- lib/adalog/web/public/stylesheets/pure/tables-min.css
+- lib/adalog/web/views/adalog.html.erb
+- lib/adalog/web/views/index.html.erb
+- test/data/simple.yml
+- test/test_helper.rb
+- test/unit/active_record_repo.rb
+- test/unit/configuration_test.rb
+- test/unit/entry_test.rb
+- test/unit/in_memory_repo_test.rb
+- test/unit/pstore_repo_test.rb
+homepage: https://github.com/swifthand/adalog
+licenses:
+- Revised BSD, see LICENSE.md
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A not-quite logger, with several storage methods. Records occurrences, provides
+  a web app for viewing entries.
+test_files:
+- test/data/simple.yml
+- test/test_helper.rb
+- test/unit/active_record_repo.rb
+- test/unit/configuration_test.rb
+- test/unit/entry_test.rb
+- test/unit/in_memory_repo_test.rb
+- test/unit/pstore_repo_test.rb