madvertise-ext 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.3-p125@madvertise-ext

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/.yardopts

@@ -0,0 +1 @@
+--protected --no-private

data/Gemfile

@@ -0,0 +1,16 @@
+source :rubygems
+
+gemspec
+
+group :development, :test do
+  gem 'bundler'
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'rake'
+  gem 'redcarpet'
+  gem 'reek'
+  gem 'rspec'
+  gem 'ruby2ruby', '=1.3.0' # 1.3.1 is broken :(
+  gem 'simplecov'
+  gem 'yard'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 madvertise Mobile Advertising GmbH
+
+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,31 @@
+# Madvertise::Ext
+
+The madvertise-ext gem provides a bunch of ruby extensions.
+
+[![Build Status](https://secure.travis-ci.org/madvertise/ext.png)](http://travis-ci.org/madvertise/ext)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'madvertise-ext'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install madvertise-ext
+
+## Usage
+
+Please refer to the [API documentation](http://rubydoc.info/gems/madvertise-ext/frames).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:spec]

data/lib/madvertise/ext/config.rb

@@ -0,0 +1,174 @@
+require 'yaml'
+require 'madvertise/ext/hash'
+
+##
+# A {Configuration} consists of one or more Sections. A section is a hash-like
+# object that responds to all keys in the hash as if they were methods:
+#
+#   > s = Section.from_hash({:v1 => 2, :nested => {:v2 => 1}})
+#   > s.v1
+#   => 2
+#   > s.nested.v2
+#   => 1
+#
+class Section < Hash
+  class << self
+
+    # Create a new section from the given hash-like object.
+    #
+    # @param [Hash] hsh  The hash to convert into a section.
+    # @return [Section]  The new {Section} object.
+    def from_hash(hsh)
+      result = new.tap do |result|
+        hsh.each do |key, value|
+          result[key.to_sym] = from_value(value)
+        end
+      end
+    end
+
+    # Convert the given value into a Section, list of Sections or the pure
+    # value. Used to recursively build the Section hash.
+    #
+    # @private
+    def from_value(value)
+      case value
+      when Hash
+        from_hash(value)
+      when Array
+        value.map do |item|
+          from_hash(item)
+        end
+      else
+        value
+      end
+    end
+  end
+
+  # Mixin a configuration snippet into the current section.
+  #
+  # @param [Hash, String] value  A hash to merge into the current
+  #                              configuration. If a string is given a filename
+  #                              is assumed and the given file is expected to
+  #                              contain a YAML hash.
+  # @return [void]
+  def mixin(value)
+    unless value.is_a?(Hash)
+      value = Section.from_hash(YAML.load(File.read(value)))
+    end
+
+    self.deep_merge!(value[:default]) if value.has_key?(:default)
+    self.deep_merge!(value[:generic]) if value.has_key?(:generic)
+
+    if value.has_key?(@mode)
+      self.deep_merge!(value[@mode])
+    else
+      self.deep_merge!(value)
+    end
+  end
+
+  # Build the call chain including NilSections.
+  #
+  # @private
+  def method_missing(name, *args)
+    if name.to_s =~ /(.*)=$/
+      self[$1.to_sym] = Section.from_value(args.first)
+    else
+      value = self[name]
+      value = value.call if value.is_a?(Proc)
+      value = NilSection.new if value.nil?
+      self[name] = value
+    end
+  end
+end
+
+##
+# The Configuration class provides a simple interface to configuration stored
+# inside of YAML files.
+#
+class Configuration < Section
+
+  # Create a new {Configuration} object.
+  #
+  # @param [Symbol] mode  The mode to load from the configurtion file
+  #                       (production, development, etc)
+  # @yield [config]  The new configuration object.
+  def initialize(mode = :development)
+    @mode = mode
+    yield self if block_given?
+  end
+
+  # Load given mixins from +path+.
+  #
+  # @param [String] path  The path to mixin files.
+  # @param [Array] mixins_to_use  A list of mixins to load from +path+.
+  # @return [void]
+  def load_mixins(path, mixins_to_use)
+    mixins_to_use.map do |mixin_name|
+      File.join(path, "#{mixin_name}.yml")
+    end.each do |mixin_file|
+      mixin(mixin_file)
+    end
+  end
+
+  ##
+  # The {Helpers} module can be included in all classes that wish to load
+  # configuration file(s). In order to load custom configuration files the
+  # including class needs to set the +@config_file+ instance variable.
+  #
+  module Helpers
+
+    # Load the configuration. The default configuration is located at
+    # +lib/ganymed/config.yml+ inside the Ganymed source tree.
+    #
+    # @return [Configuration]  The configuration object. See madvertise-ext gem
+    #                          for details.
+    def config
+      @config ||= Configuration.new(Env.mode) do |config|
+        config.mixin(@default_config_file) if @default_config_file
+        config.mixin(@config_file) if @config_file
+      end
+    end
+  end
+end
+
+##
+# A NilSection is returned for all missing/empty values in the config file. This
+# allows for terse code when accessing values that have not been configured by
+# the user.
+#
+# Consider code like this:
+#
+#   config.server.listen.tap do |listen|
+#     open_socket(listen.host, listen.port)
+#   end
+#
+# Given that your server component is optional and does not appear in the
+# configuration file at all, +config.server.listen+ will return a NilSection
+# that does not call the block given to tap _at all_.
+#
+class NilSection
+  # @return true
+  def nil?
+    true
+  end
+
+  # @return true
+  def empty?
+    true
+  end
+
+  # @return false
+  def present?
+    false
+  end
+
+  # @return self
+  def tap
+    self
+  end
+
+  # @private
+  def method_missing(*args, &block)
+    self
+  end
+end

data/lib/madvertise/ext/enumerable.rb

@@ -0,0 +1,22 @@
+module Enumerable
+  def sum
+    reduce(:+)
+  end
+
+  def mean
+    sum.to_f / length
+  end
+
+  def variance
+    m = mean
+    reduce(0) {|accum, item| accum + (item - m) ** 2}.to_f / (length - 1)
+  end
+
+  def stdev
+    Math.sqrt(variance)
+  end
+
+  def percentile(pc)
+    sort[(pc * length).ceil - 1]
+  end
+end

data/lib/madvertise/ext/environment.rb

@@ -0,0 +1,56 @@
+##
+# A simple convenience class to support multiple environments in which a
+# program can run (e.g. development, production, etc).
+#
+class Environment
+  attr_accessor :key
+
+  # Create a new Environment instance with the corresponding +key+ in the +ENV+
+  # hash.
+  #
+  # @param [String] key  The key in +ENV+ to contain the current program
+  #                      environment.
+  #
+  def initialize(key=nil)
+    @key = key
+  end
+
+  # Retreive the current environment mode.
+  #
+  # @return [String]  The current environment mode.
+  def mode
+    ENV[@key] || 'development'
+  end
+
+  # Retrieve the current environment mode and convert it to a symbol.
+  #
+  # @return [Symbol]  The current environment mode.
+  def to_sym
+    mode.to_sym
+  end
+
+  # Return true if the current environment is +production+.
+  def prod?
+    to_sym == :production
+  end
+
+  # Return true if the current environment is +development+.
+  def dev?
+    to_sym == :development
+  end
+
+  # Return true if the current environment is +test+.
+  def test?
+    to_sym == :test
+  end
+
+  # Set the environment mode.
+  #
+  # @param [String]  The new environment mode.
+  def set(value)
+    ENV[@key] = value.to_s
+  end
+end
+
+# Global instance of {Environment}.
+Env = Environment.new

data/lib/madvertise/ext/hash.rb

@@ -0,0 +1,20 @@
+##
+# Various Hash extensions.
+#
+class Hash
+
+  # Recursively merge +other_hash+ into +self+ and return the new hash.
+  def deep_merge(other_hash)
+    self.merge(other_hash) do |key, oldval, newval|
+      oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
+      newval = newval.to_hash if newval.respond_to?(:to_hash)
+      oldval.is_a?(Hash) && newval.is_a?(Hash) ? oldval.deep_merge(newval) : newval
+    end
+  end
+
+  # Recursively merge and replace +other_hash+ into +self.
+  def deep_merge!(other_hash)
+    replace(deep_merge(other_hash))
+  end
+
+end

data/lib/madvertise/ext/logging.rb

@@ -0,0 +1,38 @@
+require 'active_support/core_ext/module/attribute_accessors'
+require 'madvertise/ext/environment'
+require 'madvertise-logging'
+
+include Madvertise::Logging
+
+##
+# The {Logging} module provides a global container for the logger object.
+#
+module Logging
+  mattr_accessor :logger
+  self.logger = nil
+
+  # @private
+  def self.create_logger
+    if Env.prod?
+      ImprovedLogger.new(:syslog, $0)
+    else
+      ImprovedLogger.new(STDERR, $0)
+    end.tap do |logger|
+      logger.level = :info
+    end
+  end
+
+  ##
+  # The {Logging::Helpers} module can be included in classes that wish to use
+  # the global logger.
+  #
+  module Helpers
+
+    # Retreive and possibly create the global logger object.
+    #
+    # @return [Logger]  The logger object.
+    def log
+      Logging.logger ||= Logging.create_logger
+    end
+  end
+end

data/lib/madvertise/ext/mask.reek

@@ -0,0 +1,7 @@
+---
+NestedIterators:
+  exclude:
+    - Section#from_hash
+FeatureEnvy:
+  exclude:
+    - Hash#deep_merge

data/lib/madvertise/ext/version.rb

@@ -0,0 +1,6 @@
+# @private
+module Madvertise
+  module Ext
+    VERSION = "0.1.0"
+  end
+end

data/madvertise-ext.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/madvertise/ext/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "madvertise-ext"
+  gem.version       = Madvertise::Ext::VERSION
+  gem.authors       = ["Benedikt Böhm"]
+  gem.email         = ["benedikt.boehm@madvertise.com"]
+  gem.description   = %q{Ruby extensions}
+  gem.summary       = %q{Ruby extensions}
+  gem.homepage      = "https://github.com/madvertise/ext"
+
+  gem.add_dependency "madvertise-logging"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+end

data/spec/enumerable_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'madvertise/ext/enumerable'
+
+describe Enumerable do
+
+  it "should support the sum for a list of numbers" do
+    [1,2,3,4,5].sum.should == 15
+  end
+
+  it "should support the mean for a list of numbers" do
+    [1,2,3,4,5].mean.should == 3.0
+  end
+
+  it "should support the variance for a list of numbers" do
+    [9,8,7,6,5].variance.should == 2.5
+  end
+
+  it "should support the standard deviation for a list of numbers" do
+    [9,8,7,6,5].stdev.should == 1.5811388300841898
+  end
+
+  it "should support a percentile method for a list of numbers" do
+    [9,1,8,2,7,3,6,4,5,4,3,2,1].percentile(0.9).should == 8
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rspec'
+
+require 'simplecov'
+SimpleCov.start
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+#require 'madvertise-ext'
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end

data/tasks/reek.rake

@@ -0,0 +1,5 @@
+require 'reek/rake/task'
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+end

data/tasks/rspec.rake

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run the specs"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--options', "spec/spec.opts"]
+end

data/tasks/yard.rake

@@ -0,0 +1,5 @@
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'README.rdoc']
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: madvertise-ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Benedikt Böhm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: madvertise-logging
+  requirement: &12312600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12312600
+description: Ruby extensions
+email:
+- benedikt.boehm@madvertise.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/madvertise/ext/config.rb
+- lib/madvertise/ext/enumerable.rb
+- lib/madvertise/ext/environment.rb
+- lib/madvertise/ext/hash.rb
+- lib/madvertise/ext/logging.rb
+- lib/madvertise/ext/mask.reek
+- lib/madvertise/ext/version.rb
+- madvertise-ext.gemspec
+- spec/enumerable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/reek.rake
+- tasks/rspec.rake
+- tasks/yard.rake
+homepage: https://github.com/madvertise/ext
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3585342747307682113
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3585342747307682113
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Ruby extensions
+test_files:
+- spec/enumerable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: