locomotivecms_common 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6dbfa3ad674f1d0afe144354bdbd6fef81b23b10
+  data.tar.gz: 2e34e1e3df1a89fb78a5b3bc1ff704d8d948dfe1
+SHA512:
+  metadata.gz: e7b8b82956afa6b02810f4f24bfec3e1cb6c1b0585f616d2d8e1f4dc4dc77c46c21e4b271342d051128f055f38e293874db9bcd86fb86b856e6f9bd338dbd3b5
+  data.tar.gz: 7df648ebc689c963decd88034b07333ea53987edd756907d7d16eb1ae2f2d48c734dac82db2cfe6ce07eae9007d4f6479be42e1050fe28b0b2555398b35475e9

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+.ruby-*
+
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in locomotivecms_common.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    locomotivecms_common (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.2.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  locomotivecms_common!
+  rake (~> 10.1)
+  rspec (~> 2.14)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joel AZEMAR
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# LocomotiveCMS Common
+
+[![Gem Version](https://badge.fury.io/rb/common.png)](http://badge.fury.io/rb/locomotivecms_common)
+
+[![Code Climate](https://codeclimate.com/github/locomotivecms/common.png)](https://codeclimate.com/github/locomotivecms/common)
+
+[![Dependency Status](https://gemnasium.com/locomotivecms/common.png)](https://gemnasium.com/locomotivecms/common)
+
+[![Build Status](https://travis-ci.org/locomotivecms/common.png?branch=master)](https://travis-ci.org/locomotivecms/common) (Travis CI)
+
+[![Coverage Status](https://coveralls.io/repos/locomotivecms/common/badge.png)](https://coveralls.io/r/locomotivecms/common)
+
+# Description
+
+Common librairies for locomotive CMS Project
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'locomotivecms_common'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install locomotivecms_common
+
+## Configuration
+
+    Locomotive::Common.configure do |config|
+      config.notifier = Locomotive::Common::Logger.setup(File.join(File.expand_path(File.dirname(__FILE__)), 'log', 'locomotivecms.log'))
+    end
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/locomotivecms_common/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+require_relative 'lib/common'
+
+RSpec::Core::RakeTask.new('spec:all') do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task spec: ['spec:all']
+task default: :spec

data/bin/publish

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/common'
+
+# bin/publish
+
+class Publish
+
+  def start
+    # if File.exists? '.ruby-version'
+    #   cmd = <<-CMD
+    #     rvm use `cat .ruby-version`@`cat .ruby-gemset` --create
+    #   CMD
+    #   system cmd
+    # end
+    # exit 1
+
+    system "bundle && bundle exec rspec"
+    system "gem build locomotivecms_common.gemspec"
+    system "git tag -a v#{Locomotive::Common::VERSION} -m 'version #{Locomotive::Common::VERSION}'"
+    system "git push --tags"
+    system "gem push locomotivecms_common-#{Locomotive::Common::VERSION}.gem"
+    system "git push origin master"
+  end
+
+end
+
+Publish.new.start

data/lib/common.rb

@@ -0,0 +1,31 @@
+require_relative 'locomotive/common/version'
+require_relative 'locomotive/common/logger'
+require_relative 'locomotive/common/exception'
+require_relative 'locomotive/common/notifier'
+
+require_relative 'locomotive/common/configuration'
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+module Locomotive
+  module Common
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+  end
+end

data/lib/locomotive/common/configuration.rb

@@ -0,0 +1,13 @@
+module Locomotive
+  module Common
+
+    class Configuration
+      attr_accessor :notifier
+
+      def initialize
+        @notifier = Locomotive::Common::Notifier.new
+      end
+    end
+
+  end
+end

data/lib/locomotive/common/exception.rb

@@ -0,0 +1,60 @@
+require 'pry'
+
+module Locomotive
+  module Common
+
+    class DefaultException < ::Exception
+      attr_accessor :notifier
+
+      def initialize(message = nil, parent_exception = nil)
+        self.notifier = Locomotive::Common.configuration.notifier
+        self.log_backtrace(parent_exception) if parent_exception
+        super(message)
+        init_plugins
+      end
+
+      def init_plugins
+        begin
+          @plugins = []
+          ::Plugins.constants.each do |name|
+            @plugins << ::Plugins.const_get(name).new(self)
+          end
+        rescue NameError
+        end
+      end
+
+      protected
+
+      def log_backtrace(parent_exception)
+        full_error_message = "#{parent_exception.message}\n\t"
+        full_error_message += parent_exception.backtrace.join("\n\t")
+        full_error_message += "\n\n"
+
+        notifier.fatal full_error_message
+      end
+    end
+
+    class RendererException < DefaultException
+      attr_accessor :name, :template, :liquid_context
+
+      def initialize(exception, name, template, liquid_context)
+        self.name, self.template, self.liquid_context = name, template, liquid_context
+        self.log_page_into_backtrace(exception)
+        super(exception.message)
+        self.set_backtrace(exception.backtrace)
+      end
+
+      def log_page_into_backtrace(exception)
+        line = self.template.line_offset
+        line += (exception.respond_to?(:line) ? exception.line || 0 : 0) + 1
+        message = "#{self.template.filepath}:#{line}:in `#{self.name}'"
+        notifier.fatal "[ERROR] #{exception.message} - #{message}\n".red
+        exception.backtrace.unshift message
+      end
+    end
+
+    class MounterException < DefaultException; end
+    class GeneratorException < DefaultException; end
+
+  end
+end

data/lib/locomotive/common/logger.rb

@@ -0,0 +1,69 @@
+module Locomotive
+  module Common
+
+    class Logger
+
+      attr_accessor :logger
+
+      def initialize
+        self.logger = nil
+      end
+
+      # Setup the single instance of the ruby logger.
+      #
+      # @param[ optional ] [ String ] path The path to the log file, full path with log file name
+      # Sample /home/locomotivecms/log/server.log (default: nil => Stdout)
+      #
+      def setup log_file_full_path=nil
+        require 'logger'
+
+        output = begin
+          if log_file_full_path
+            log_file_path log_file_full_path
+          else
+            STDOUT
+          end
+        end
+
+        self.logger = ::Logger.new(output).tap do |log|
+          log.level = ::Logger::DEBUG
+          log.formatter = proc do |severity, datetime, progname, msg|
+            "#{msg}\n"
+          end
+        end
+      end
+
+      def self.instance
+        @@instance ||= self.new
+      end
+
+      def self.setup *args
+        if args.size > 1
+          puts "[DEPRECATION] Logger.setup(path, stdout=false) is deprecated. " \
+            "Please use Logger.setup(log_file_full_path) instead, " \
+            "like: /home/locomotivecms/log/server.log"
+        end
+        self.instance.setup args.first
+      end
+
+      class << self
+        %w(debug info warn error fatal unknown).each do |name|
+          define_method(name) do |message|
+            self.instance.logger.send(name.to_sym, message)
+          end
+        end
+      end
+
+      private
+
+      def log_file_path log_file_full_path
+        if File.directory? log_file_full_path
+          puts "[DEPRECATION] Please use fully log file path like: /home/locomotivecms/log/server.log"
+          File.expand_path(File.join(log_file_full_path, 'log', 'locomotivecms.log'))
+        else
+          log_file_full_path
+        end.tap { |path| FileUtils.mkdir_p(File.dirname(path)) }
+      end
+    end
+  end
+end

data/lib/locomotive/common/notifier.rb

@@ -0,0 +1,11 @@
+module Locomotive
+  module Common
+
+    class Notifier
+      def method_missing method, *args
+        nil
+      end
+    end
+
+  end
+end

data/lib/locomotive/common/version.rb

@@ -0,0 +1,5 @@
+module Locomotive
+  module Common
+    VERSION = '0.0.1'
+  end
+end

data/lib/plugins/notifier.rb

@@ -0,0 +1,17 @@
+# # Sample
+#
+# module Plugins
+#
+#   class Notifier
+#     def initialize receiver
+#       receiver.notifier.extend(SilentLogger)
+#     end
+#
+#     module SilentLogger
+#       def fatal(*)
+#         nil
+#       end
+#     end
+#   end
+#
+# end

data/locomotivecms_common.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/common'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'locomotivecms_common'
+  spec.version       = Locomotive::Common::VERSION
+  spec.authors       = ['Didier Lafforgue', 'Arnaud Sellenet', 'Joel Azemar']
+  spec.email         = ['did@locomotivecms.com', 'arnaud@sellenet.fr', 'joel.azemar@gmail.com']
+  spec.description   = %q{The LocomotiveCMS Common is a shared libraries package}
+  spec.summary       = %q{The LocomotiveCMS Common is a shared libraries package for all LocomotiveCMS dependencies}
+  spec.homepage      = 'http://www.locomotivecms.com'
+  spec.homepage      = 'https://github.com/locomotivecms/common'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake',    '~> 10.1'
+  spec.add_development_dependency 'rspec',   '~> 2.14'
+
+  spec.required_ruby_version = '~> 2.0'
+end

data/spec/locomotive/exception_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Locomotive::Common::DefaultException do
+
+  specify do
+    expect do
+      raise Locomotive::Common::DefaultException.new
+    end.to raise_error(Locomotive::Common::DefaultException)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require_relative '../lib/common'
+
+RSpec.configure do |config|
+  config.filter_run focused: true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: locomotivecms_common
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Didier Lafforgue
+- Arnaud Sellenet
+- Joel Azemar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-14 00:00:00.000000000 Z
+dependencies:
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: The LocomotiveCMS Common is a shared libraries package
+email:
+- did@locomotivecms.com
+- arnaud@sellenet.fr
+- joel.azemar@gmail.com
+executables:
+- publish
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/publish
+- lib/common.rb
+- lib/locomotive/common/configuration.rb
+- lib/locomotive/common/exception.rb
+- lib/locomotive/common/logger.rb
+- lib/locomotive/common/notifier.rb
+- lib/locomotive/common/version.rb
+- lib/plugins/notifier.rb
+- locomotivecms_common.gemspec
+- spec/locomotive/exception_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/locomotivecms/common
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: The LocomotiveCMS Common is a shared libraries package for all LocomotiveCMS
+  dependencies
+test_files:
+- spec/locomotive/exception_spec.rb
+- spec/spec_helper.rb