alephant 0.0.6-java → 0.0.7-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1840eda13ae723ff872f73da21ee753fc9e8ed6
-  data.tar.gz: 60f842f7a8a2b0f4787d9394fe5af967a6887eea
+  metadata.gz: df75578b70f5f4edee18315d47acdd5b446b319b
+  data.tar.gz: 7c21430e5949075f3fb2ea9db699a117a913ac77
 SHA512:
-  metadata.gz: 177994daa57df4abae27d9494d11d0e3074f2d6451d2a45795f4339ff65f55c82e65996d1ac746c49e42677d60454e14364ee929bd73a96c9718ff199fb7bbc2
-  data.tar.gz: fe480adb9ca995f169843f02540d2c95b16b5f214aacf6c4635f2029da0dfd0aee4202b41a77f5dc0ecf604d8f9045b4c50882e2f5b54da230c0800966dd6f96
+  metadata.gz: df985a135a85c1fd05f060c897c1e3408b3531d930cc2473862d06be1af3843ee7d54577e085fae4e2276a2abb2c3392d424a3a6308d7856c7125f82ec1ccdfb
+  data.tar.gz: 0ef61361d4139f8199437adee01356386c37553f261d9b129e262b886cf3cb28622007e0450d4d10207d3b2da628dd61e91ba393191349ff13caec6857c35659

data/README.md

@@ -50,10 +50,14 @@ opts = {
   }
 }
 
-thread = Alephant::Alephant.new(opts).run!
+logger = Logger.new
+
+thread = Alephant::Alephant.new(opts, logger).run!
 thread.join
 ```
 
+logger is optional, and must confirm to the Ruby standard logger interface
+
 Provide a view in a folder:
 
 ```

data/alephant.gemspec

@@ -7,7 +7,7 @@ require 'alephant/version'
 Gem::Specification.new do |s|
   s.name        = 'alephant'
   s.version     = Alephant::VERSION
-  s.date        = '2014-01-08'
+  s.date        = Time.now.strftime "%Y-%m-%d"
   s.summary     = "Static Publishing in the Cloud"
   s.description = "Static publishing to S3 based on SQS messages"
   s.authors     = ["Robert Kenny"]

data/lib/alephant.rb

@@ -5,6 +5,7 @@ require 'json'
 
 require_relative 'env'
 
+require 'alephant/models/logger'
 require 'alephant/models/queue'
 require 'alephant/models/cache'
 require 'alephant/models/renderer'
@@ -29,7 +30,8 @@ module Alephant
       :set_last_seen_proc
     ]
 
-    def initialize(opts = {})
+    def initialize(opts = {}, logger = nil)
+      set_logger(logger)
       set_opts(opts)
 
       @sequencer = Sequencer.new(
@@ -44,6 +46,10 @@ module Alephant
       @renderer = Renderer.new(@view_id, @view_path)
     end
 
+    def set_logger(logger)
+      ::Alephant.logger = logger
+    end
+
     def parse(msg)
       JSON.parse(msg)
     end

data/lib/alephant/models/cache.rb

@@ -5,18 +5,22 @@ module Alephant
     attr_reader :id, :bucket, :path
 
     def initialize(id, path)
+      @logger = ::Alephant.logger
       @id = id
       @path = path
 
       s3 = AWS::S3.new
       @bucket = s3.buckets[id]
+      @logger.info("Cache.initialize: end with id #{id} and path #{path}")
     end
 
     def put(id, data)
       @bucket.objects["#{@path}/#{id}"].write(data)
+      @logger.info("Cache.put: #{@path}/#{id} and write data #{data}")
     end
 
     def get(id)
+      @logger.info("Cache.get: #{@path}/#{id}")
       @bucket.objects["#{@path}/#{id}"].read
     end
   end

data/lib/alephant/models/logger.rb

@@ -0,0 +1,22 @@
+require 'logger'
+
+module Alephant
+  def self.logger
+    ::Alephant::LogSystem.logger
+  end
+
+  def self.logger=(value)
+    ::Alephant::LogSystem.logger = value
+  end
+
+  class LogSystem
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def self.logger=(value)
+      @logger = value
+    end
+  end
+end
+

data/lib/alephant/models/queue.rb

@@ -5,13 +5,18 @@ module Alephant
     attr_accessor :q
 
     def initialize(id)
+      @logger = ::Alephant.logger
+
       @sqs = AWS::SQS.new
       @q = @sqs.queues[id]
 
       unless @q.exists?
         @q = @sqs.queues.create(id)
         sleep_until_queue_exists
+        @logger.info("Queue.initialize: created queue with id #{id}")
       end
+
+      @logger.info("Queue.initialize: ended with id #{id}")
     end
 
     def sleep_until_queue_exists
@@ -19,6 +24,7 @@ module Alephant
     end
 
     def poll(*args, &block)
+      @logger.info("Queue.poll: polling with arguments #{args}")
       @q.poll(*args, &block)
     end
   end

data/lib/alephant/models/renderer.rb

@@ -8,11 +8,16 @@ module Alephant
     attr_reader :id
 
     def initialize(id, view_base_path=nil)
+      @logger = ::Alephant.logger
+
       @id = id
       self.base_path = view_base_path unless view_base_path.nil?
+
+      @logger.info("Renderer.initialize: end with self.base_path set to #{self.base_path}")
     end
 
     def render(data)
+      @logger.info("Renderer.render: rendered template with id #{id} and data #{data}")
       Mustache.render(
         template(@id),
         model(@id,data)
@@ -27,30 +32,34 @@ module Alephant
       if File.directory?(path)
         @base_path = path
       else
+        @logger.error("Renderer.base_path=(path): error of invalid view path #{path}")
         raise Errors::InvalidViewPath
       end
     end
 
     def model(id, data)
-      model_location =
-        File.join(base_path,'models',"#{id}.rb")
+      model_location = File.join(base_path, 'models', "#{id}.rb")
 
       begin
         require model_location
         klass = ::Alephant::Views.get_registered_class(id)
+        @logger.info("Renderer.model: klass set to #{klass}")
       rescue Exception => e
+        @logger.error("Renderer.model: view model with id #{id} not found")
         raise Errors::ViewModelNotFound
       end
 
+      @logger.info("Renderer.model: creating new klass with data #{data}")
       klass.new(data)
     end
 
     def template(id)
-      template_location =
-        File.join(base_path,'templates',"#{id}.mustache")
+      template_location = File.join(base_path,'templates',"#{id}.mustache")
       begin
+        @logger.info("Renderer.template: #{template_location}")
         File.open(template_location).read
       rescue Exception => e
+        @logger.error("Renderer.template: view tempalte with id #{id} not found")
         raise Errors::ViewTemplateNotFound
       end
     end

data/lib/alephant/models/sequencer.rb

@@ -18,6 +18,8 @@ module Alephant
     end
 
     def initialize(opts, id)
+      @logger = ::Alephant.logger
+
       dynamo_db = AWS::DynamoDB.new
 
       @id = id
@@ -28,6 +30,8 @@ module Alephant
       begin
         sleep_until_table_active
       rescue AWS::DynamoDB::Errors::ResourceNotFoundException
+        @logger.error("Sequencer.initialize: DynamoDB resource was not found.")
+
         @table = dynamo_db.tables.create(
           @table_name,
           @table_conf[:read_units],
@@ -35,8 +39,12 @@ module Alephant
           @table_conf[:schema]
         )
 
+        @logger.info("Sequencer.initialize: Creating table with name #{@table_name}, read units #{@table_conf[:read_units]}, write units #{@table_conf[:write_units]}, schema #{@table_conf[:schema]}")
+
         sleep_until_table_active
       end
+
+      @logger.info("Sequencer.initialize: end with id #{@id}")
     end
 
     def sequential?(data)
@@ -53,6 +61,7 @@ module Alephant
       batch = AWS::DynamoDB::BatchWrite.new
       batch.put(@table_name, [:key => @id,:value => last_seen_id])
       batch.process!
+      @logger.info("Sequencer.set_last_seen: id #{id} and last_seen_id #{last_seen_id}")
     end
 
     def get_last_seen
@@ -65,6 +74,7 @@ module Alephant
           }
         ).first["value"].to_i
       rescue
+        @logger.error("Sequencer.get_last_seen: id #{id}")
         0
       end
     end

data/lib/alephant/version.rb

@@ -1,3 +1,3 @@
 module Alephant
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/alephant/views.rb

@@ -1,6 +1,6 @@
-module Alephant::Views
-  autoload :Base, 'alephant/views/base'
+require 'alephant/views/base'
 
+module Alephant::Views
   @@views = {}
 
   def self.register(klass)

data/lib/env.rb

@@ -3,7 +3,7 @@ require 'yaml'
 
 require 'alephant/util/string'
 
-config_file = File.join("config", "aws.yml")
+config_file = File.join('config', 'aws.yaml')
 
 if File.exists? config_file
   config = YAML.load(File.read(config_file))

data/spec/logger_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Alephant::LogSystem do
+  before(:each) do
+    sequencer = double()
+    queue     = double()
+    cache     = double()
+    renderer  = double()
+
+    Alephant::Sequencer.any_instance.stub(:initialize).and_return(sequencer)
+    Alephant::Queue.any_instance.stub(:initialize).and_return(queue)
+    Alephant::Cache.any_instance.stub(:initialize).and_return(cache)
+    Alephant::Renderer.any_instance.stub(:initialize).and_return(renderer)
+  end
+
+  after(:each) do
+    Alephant.logger = nil
+  end
+
+  let (:instance) { Alephant::Alephant }
+  subject { Alephant::LogSystem }
+
+  describe "::Alephant::LogSystem.logger" do
+    context "Logger not provided" do
+      it "return Ruby built-in Logger" do
+        instance.new
+        expect(Alephant.logger.class).to be(Logger)
+      end
+    end
+
+    context "Logger provided" do
+      it "return custom Logger" do
+        class FakeLogger; end
+        instance.new({}, FakeLogger.new)
+        expect(Alephant.logger.class).to be(FakeLogger)
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -2,4 +2,5 @@ $: << File.join(File.dirname(__FILE__),"..", "lib")
 
 require 'pry'
 require 'alephant'
+require 'logger'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: java
 authors:
 - Robert Kenny
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -171,6 +171,7 @@ files:
 - lib/alephant/errors/view_model_not_found.rb
 - lib/alephant/errors/view_template_not_found.rb
 - lib/alephant/models/cache.rb
+- lib/alephant/models/logger.rb
 - lib/alephant/models/queue.rb
 - lib/alephant/models/renderer.rb
 - lib/alephant/models/sequencer.rb
@@ -183,6 +184,7 @@ files:
 - spec/cache_spec.rb
 - spec/fixtures/views/models/example.rb
 - spec/fixtures/views/templates/example.mustache
+- spec/logger_spec.rb
 - spec/queue_spec.rb
 - spec/renderer_spec.rb
 - spec/sequencer_spec.rb
@@ -216,6 +218,7 @@ test_files:
 - spec/cache_spec.rb
 - spec/fixtures/views/models/example.rb
 - spec/fixtures/views/templates/example.mustache
+- spec/logger_spec.rb
 - spec/queue_spec.rb
 - spec/renderer_spec.rb
 - spec/sequencer_spec.rb