sapience 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bbf1f419c40131407dc53eccc467636462c6627
-  data.tar.gz: 2556a1353dfc63228882845c6515b186ef9c7fb4
+  metadata.gz: 11cce05eedf1219a30f6da98358d1047be347bb5
+  data.tar.gz: 439781b493d904279964f6b6dc74caea43058082
 SHA512:
-  metadata.gz: 2cbd70840bd75008f69b8501dc12dd1dc4b64f7fc338beff143a2ea4bba3f9358a298e1b84d34bc32124b38a8b7f84e3f5b0ca6230a772ebb5d1a51332ecfde7
-  data.tar.gz: 9101d5a36a37c8061eea06d930c2a55161ca2d44d75c687d7e5a9d48127dd81ceeebac358e8d0859db9887455da361adc71daac6af5111621cd877fc1e3132b0
+  metadata.gz: 702c8f1c1af9e49c5a2f0b3f352c4f2d0835836952e420e3e827a105b586723041605ff76ef29b1ffb1eea351a466faeabc79fa29be639e890b31b3a3581a1aa
+  data.tar.gz: 750f844879a9d7b5d886bc5e3fdc2a7e7aa8cf8b33487e3b090494d0b71c7b3d55b86ab2b36435abe5dbad838b8bd85a4adc028389b6b0b04afc71a78556cfb6

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v1.0.3
+
+- Rename `SAPIENCE_APP_NAME` to `APP_NAME`
+- Allow for configuration inheritance (see the history for [config_loader.rb](https://github.com/reevoo/sapience-rb/blame/master/lib/sapience/config_loader.rb#L19))
+
 ## v1.0.2
 
 - Require `app_name` to be configured. Either set it with the environment variable `SAPIENCE_APP_NAME` or provided it when configuring the application.

data/README.md

@@ -58,7 +58,6 @@ The `app_name` is required to be configured. Sapience will fail on startup if ap
 Sapience.configure do |config|
   config.default_level   = :info
   config.backtrace_level = :error
-  config.app_name        = "my_app"
   config.appenders       = [
     { stream: { io: STDOUT, formatter: :color } },
     { sentry: { dsn: "https://username:password@app.getsentry.com/00000" } },
@@ -105,6 +104,47 @@ production:
         formatter: json
 ```
 
+
+#### Configuration Inheritance
+
+We will use our default (or overriden - see [reevoo_sapience-rb](https://github.com/reevoo/reevoo_sapience-rb) for more info) configuration as a base. Any configuration specified inside a `config/sapience.yml` file will then me merged into the default or overridded config.
+
+The merge will take place not at the top level but at the environment level. This means that everything inside the environment keys will be replaced with a more specific application config.
+
+Then if a configure block is used that will take presedence.
+
+#### App name
+
+Sapience requires an application name to be set for your loggs and such. We decided not to guess what name you want to give your application so there will be no magic involved here. There are 3 different ways of configuring the app_name for Sapience.
+
+##### Environment variables
+
+This is the preferable way. If you have many environments look into using something like dotenv locally and use the power of devops and automation for your production environments.
+
+```bash
+APP_NAME="My Application" bundle exec rails server -p 9000
+```
+
+##### Configuration file
+
+If you are in need of overriding the sapience default configuration an app_name can be used for any environment but we recommend you specify the app_name for the default section. That way you don't have to specify app_name for each environment and avoid some duplicated keys. Of course if you need to specify different app names for various environments by all means do.
+
+```yaml
+---
+default:
+  app_name: My Application
+```
+
+##### Configuration block
+
+This will be the top priority and is the first check. The reasoning is that if someone has taken the time to use configure with a block that should override anything set in file configuration or environment.
+
+```ruby
+Sapience.configure do |config|
+  config.app_name = "My Application"
+end
+```
+
 ## Appenders
 
 One of the things that did not suite us so well with the Semantic Logger approach was that they made a distinction between metrics and appenders. In our view anything that should potentially log something somewhere should be treated as an appender.
@@ -204,7 +244,7 @@ Formatters can be specified by using the key `formatter: :camelized_formatter_na
 
 ## Environment variables
 
-`SAPIENCE_APP_NAME` - If you want to provide an application name for sapience
+`APP_NAME` - If you want to provide an application name for sapience it can be done here.
 `SAPIENCE_ENV` - For applications that don't use rack or rails
 
 ## Contributing

data/docker-compose.yml

@@ -56,7 +56,7 @@ services:
     depends_on:
       - rabbitmq
     environment:
-      SAPIENCE_APP_NAME: rails_app
+      APP_NAME: rails_app
       AMQP: amqp://sapience:tests@rabbitmq:5672
       PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
 
@@ -69,5 +69,5 @@ services:
     entrypoint: /usr/src/app/dev-entrypoint.sh
     command: bundle exec rspec
     environment:
-      SAPIENCE_APP_NAME: grape_app
+      APP_NAME: grape_app
       PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

data/lib/sapience/appender/datadog.rb

@@ -106,8 +106,8 @@ module Sapience
       end
 
       def namespace
-        ns = Sapience.app_name
-        ns << ".#{Sapience.environment}" if Sapience.environment
+        ns = Sapience.namify(Sapience.app_name)
+        ns << ".#{Sapience.namify(Sapience.environment)}" if Sapience.environment
         ns
       end
 

data/lib/sapience/config_loader.rb

@@ -17,18 +17,28 @@ module Sapience
     DEFAULT_FILE  = File.join(SAPIENCE_HOME, "config", "default.yml")
 
     def self.load_from_file
-      file_path = config_file_path
-      path = File.absolute_path(file_path)
-      load_yaml_configuration(path)
+      default_config     = load_yaml_configuration(config_file_path)
+      application_config = load_yaml_configuration(application_config_file)
+      merge_configs(default_config, application_config)
+    end
+
+    def self.merge_configs(left_config = {}, right_config = {})
+      left_config.each do |key, config = {}|
+        right = right_config.fetch(key) { Hash.new }
+        config.merge!(right)
+      end
+
+      (right_config.keys - left_config.keys).each do |left_over_key|
+        left_config[left_over_key] = right_config[left_over_key]
+      end
+      left_config
     end
 
     class << self
       private
 
       def config_file_path
-        return application_config_file if File.exist?(application_config_file)
-
-        DEFAULT_FILE
+        File.absolute_path(DEFAULT_FILE)
       end
 
       def application_config_file
@@ -44,6 +54,7 @@ module Sapience
       end
 
       def load_yaml_configuration(absolute_path)
+        return {} unless File.exist?(absolute_path)
         text      = IO.read(absolute_path, encoding: "UTF-8")
         erb       = ERB.new(text)
         yaml_code = erb.result

data/lib/sapience/sapience.rb

@@ -27,20 +27,40 @@ module Sapience
 
   # Logging levels in order of most detailed to most severe
   LEVELS = [:trace, :debug, :info, :warn, :error, :fatal].freeze
-  DEFAULT_ENV       = "default".freeze
-  RACK_ENV          = "RACK_ENV".freeze
-  RAILS_ENV         = "RAILS_ENV".freeze
-  SAPIENCE_APP_NAME = "SAPIENCE_APP_NAME".freeze
-  SAPIENCE_ENV      = "SAPIENCE_ENV".freeze
+  APP_NAME     = "APP_NAME".freeze
+  DEFAULT_ENV  = "default".freeze
+  RACK_ENV     = "RACK_ENV".freeze
+  RAILS_ENV    = "RAILS_ENV".freeze
+  SAPIENCE_ENV = "SAPIENCE_ENV".freeze
+
+  # TODO: Maybe when configuring with a block we should create a new config?
+  # See the TODO note on .config for more information
+  def self.configure(force: false)
+    yield config if block_given?
+    return config if configured? && force == false
+    reload_config!
+    reset_appenders!
+    add_appenders(*config.appenders)
+    @@configured = true
+
+    config
+  end
+
+  def self.config_hash
+    @@config_hash ||= ConfigLoader.load_from_file
+  end
+
+  def self.reload_config!
+    @@config_hash = ConfigLoader.load_from_file
+  end
 
   # TODO: Should we really always read from file?
   # What if someone wants to configure sapience with a block
   # without reading the default.yml?
   def self.config
     @@config ||= begin
-      config    = ConfigLoader.load_from_file
-      options   = config[environment]
-      options ||= default_options(config)
+      options   = config_hash[environment]
+      options ||= default_options(config_hash)
       Configuration.new(options)
     end
   end
@@ -63,6 +83,7 @@ module Sapience
     @@environment = nil
     @@app_name = nil
     @@configured = false
+    @@config_hash = nil
     clear_tags!
     reset_appenders!
   end
@@ -89,12 +110,12 @@ module Sapience
   end
 
   def self.app_name
-    @@app_name ||= begin
-      appname = ENV.fetch(SAPIENCE_APP_NAME) do
-        config.app_name
-      end
-      namify(appname)
-    end
+    @@app_name ||= config.app_name
+    @@app_name ||= config_hash.fetch(environment) { {} }["app_name"]
+    @@app_name ||= config_hash.fetch(DEFAULT_ENV) { {} }["app_name"]
+    @@app_name ||= ENV[APP_NAME]
+    fail AppNameMissing, "app_name is not configured. See documentation for more information" unless @@app_name
+    @@app_name
   end
 
   def self.namify(appname, sep = "_")
@@ -113,21 +134,6 @@ module Sapience
     end
     appname.downcase
   end
-  private_class_method :namify
-
-
-  # TODO: Maybe when configuring with a block we should create a new config?
-  # See the TODO note on .config for more information
-  def self.configure(force: false)
-    yield config if block_given?
-    fail AppNameMissing, "app_name is not configured. See documentation for more information" unless app_name
-    return config if configured? && force == false
-    reset_appenders!
-    add_appenders(*config.appenders)
-    @@configured = true
-
-    config
-  end
 
   # Return a logger for the supplied class or class_name
   def self.[](klass)

data/lib/sapience/version.rb

@@ -1,3 +1,3 @@
 module Sapience
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/test_apps/grape/gemfiles/grape_0.16.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sapience (1.0.1)
+    sapience (1.0.2)
       concurrent-ruby (~> 1.0)
 
 GEM
@@ -94,7 +94,7 @@ GEM
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
     ruby-progressbar (1.8.1)
-    sentry-raven (1.2.3)
+    sentry-raven (2.0.1)
       faraday (>= 0.7.6, < 0.10.x)
     simplecov (0.12.0)
       docile (~> 1.1.0)

data/test_apps/grape/gemfiles/grape_0.17.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sapience (1.0.1)
+    sapience (1.0.2)
       concurrent-ruby (~> 1.0)
 
 GEM
@@ -93,7 +93,7 @@ GEM
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
     ruby-progressbar (1.8.1)
-    sentry-raven (1.2.3)
+    sentry-raven (2.0.1)
       faraday (>= 0.7.6, < 0.10.x)
     simplecov (0.12.0)
       docile (~> 1.1.0)

data/test_apps/rails/spec/rails_helper.rb

@@ -28,9 +28,6 @@ RSpec.configure do |config|
   config.filter_rails_from_backtrace!
   config.before(:each) do
     Sapience.reset!
-  end
-
-  config.before(:each) do
     FileUtils.cp(
       Rails.root.join("spec/fixtures/sapience.yml"),
       Rails.root.join("config/sapience.yml"),

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2016-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby