dice_bag 0.4.0

data/lib/dice_bag.rb

@@ -0,0 +1,4 @@
+require_relative 'dice_bag/available_templates'
+module DiceBag
+  require 'dice_bag/railtie' if defined?(Rails)
+end

data/lib/dice_bag/available_templates.rb

@@ -0,0 +1,45 @@
+# This class returns all the templates we can generate in this particular project
+module DiceBag
+ 
+  class AvailableTemplates
+
+    class << self
+
+      def template_checkers
+        @template_checkers ||= []
+      end
+
+      def inherited(base)
+        template_checkers << base
+      end
+
+      def all
+        #all the classes than inherit from us in the ruby runtime
+        available_templates = []
+
+        template_checkers.each do |checker|
+          checker.new.templates.each do |template|
+            available_templates.push( template)
+          end
+        end
+        available_templates
+      end
+
+      def template_filename_for(filename)
+        self.all.each do |template_filename|
+          if template_filename.include? filename
+            return template_filename
+          end
+        end
+      end
+    end
+
+  end
+
+end
+
+
+# we require the our own templates checker here, for other gems we just need 
+# them to inherit from DiceBag::AvailableTemplates and require the file 
+# If Ruby loads the file we can find the class in the object space and call it
+require_relative 'templates/gems_checker'

data/lib/dice_bag/command.rb

@@ -0,0 +1,43 @@
+require 'dice_bag/available_templates'
+require 'dice_bag/project'
+require 'dice_bag/config_file'
+require 'dice_bag/template_file'
+require 'dice_bag/default_template_file'
+
+module DiceBag
+  #This class seems a candidate to be converted to Thor, the problem is that we need to run
+  #in the same process than the rake task so all the gems are loaded before dice_bag
+  #is called and dice_bag can find what software is used in this project
+  class Command
+
+    def write_all
+      Project.templates_to_generate.each do |template|
+        write(template)
+      end
+    end
+
+    def write(template_name)
+      template_file = TemplateFile.new(template_name)
+      template_file.assert_existence
+      config_file = ConfigFile.new(template_name)
+
+      template_file.create_file(config_file)
+    end
+
+
+    def generate_all_templates
+      AvailableTemplates.all.each do |template|
+        generate_template(template)
+      end
+    end
+
+    def generate_template(file)
+      default_template = DefaultTemplateFile.new(file)
+      default_template.assert_existence
+      project_template = TemplateFile.new(File.basename(file))
+
+      default_template.create_file(project_template)
+    end
+
+  end
+end

data/lib/dice_bag/config_file.rb

@@ -0,0 +1,14 @@
+require 'dice_bag/dice_bag_file.rb'
+require 'dice_bag/project'
+
+#this class encapsulate a configuration file of the project
+module DiceBag
+
+  class ConfigFile
+    include DiceBagFile
+    def initialize(name)
+      @filename = name.gsub('.local', '').gsub('.erb', '').gsub('.template','')
+      @file = @filename
+    end
+  end
+end

data/lib/dice_bag/configuration.rb

@@ -0,0 +1,40 @@
+module DiceBag
+
+  # This class abstracts access to configuration values, to be used within ERB
+  # templates. Currently, the values are read from the environment, as per the
+  # Twelve-Factor App principles.
+  class Configuration
+
+    def initialize
+      @prefixed = Hash.new
+    end
+
+    # Returns a Configuration::PrefixedWithFallback using the given +prefix+.
+    #
+    def [](prefix)
+      @prefixed[prefix] ||= PrefixedWithFallback.new(prefix, self)
+    end
+
+    def method_missing(name)
+      ENV[name.to_s.upcase]
+    end
+
+    # This class acts like +Configuration+ but with a prefix applied to the
+    # environment variables used to provide values. This is useful for providing
+    # per-environment overrides to value in Rails projects. If the prefixed
+    # environment variable is not found, the class delegates to the provided
+    # fallback Configuration class, without the prefix.
+    #
+    class PrefixedWithFallback
+      def initialize(prefix, fallback)
+        @prefix = prefix.to_s.upcase
+        @fallback = fallback
+      end
+
+      def method_missing(name)
+        ENV["#{ @prefix }_#{ name.to_s.upcase }"] || @fallback.send(name)
+      end
+    end
+  end
+
+end

data/lib/dice_bag/default_template_file.rb

@@ -0,0 +1,34 @@
+require 'dice_bag/dice_bag_file'
+require 'dice_bag/project'
+
+require 'tempfile'
+
+#This file encapsulate the template files Dicebag brings with itself
+module DiceBag
+
+  class DefaultTemplateFile
+    include DiceBagFile
+
+    def initialize(name)
+      #if called from command line with only a name we search in all our templates for the file
+      if (File.dirname(name) == '.')
+        name = AvailableTemplates.template_filename_for(name)
+      end
+      @filename = File.basename(name)
+      @file = name
+    end
+
+    def create_file(template_file)
+      contents = read_template(@file)
+      template_file.write(contents)
+      puts "new template file generated in #{template_file.file}.
+            execute 'rake config:all' to get the corresponding configuration file."
+    end
+
+    def read_template(template)
+      # Some templates need the name of the project. We put a placeholder
+      # PROJECT_NAME there, it gets substituted by the real name of the project here
+      File.readlines(template).join.gsub("PROJECT_NAME", Project.name)
+    end
+  end
+end

data/lib/dice_bag/dice_bag_file.rb

@@ -0,0 +1,59 @@
+require 'dice_bag/version'
+
+# This module contains common methods for all the type of files Dicebag knows about:
+# configuration files, templates files in the project an templates files shipped with dicebag
+module DiceBag
+  module DiceBagFile
+    attr_reader :file, :filename
+    @@force = false
+
+    def assert_existence
+      unless File.exists?(@file)
+        raise "File #{@file} not found. Configuration file not created"
+      end
+    end
+
+    def write(contents)
+      File.open(@file, 'w') do |file|
+        file.puts(contents)
+      end
+    end
+
+    def should_write?(new_contents)
+      #we always overwrite if we are inside an script or we are not development
+      return true if @@force || !$stdin.tty? || ENV['RAILS_ENV'] == 'test' || ENV['RAILS_ENV'] == 'production'
+      return true if !File.exists?(file)
+      return false if diff(file, new_contents).empty?
+
+      while true
+        puts "Overwrite #{file} ?    Recommended: Yes. "
+        puts " [Y]es, [n]o, [a]ll files, [q]uit, [d]show diff"
+        answer = $stdin.gets.tap{|text| text.strip!.downcase! if text}
+        case answer
+        when 'y'
+          return true
+        when 'n'
+          return false
+        when 'a'
+          return @@force = true
+        when 'q'
+          exit
+        when 'd'
+          puts diff(file, new_contents)
+        else
+          return true
+        end
+      end
+    end
+
+    private
+    def diff(destination, content)
+      diff_cmd = ENV['RAILS_DIFF'] || 'diff -u'
+      Tempfile.open(File.basename(destination), File.dirname(destination)) do |temp|
+        temp.write content
+        temp.rewind
+        `#{diff_cmd} #{destination} #{temp.path}`.strip
+      end
+    end
+  end
+end

data/lib/dice_bag/project.rb

@@ -0,0 +1,27 @@
+#This class encapsulate data about the project dice_bag got in
+module DiceBag
+
+  class Project
+
+    DEFAULT_NAME = 'project'
+    def self.name
+      #TODO: how to do find the name of the project in no-rails environments?
+      defined?(Rails) ? Rails.application.class.parent_name.downcase : DEFAULT_NAME
+    end
+
+    def self.config_files(filename)
+      File.join(Dir.pwd, filename)
+    end
+
+    #local templates always takes preference over generated templates
+    def self.templates_to_generate
+      generated_templates = Dir[Project.config_files("**/config/*.erb")]
+      custom_templates = Dir[Project.config_files("**/config/*.erb.local")]
+      dotNetTemplates = Dir[Project.config_files("**/*.config.template")]
+      all_files = generated_templates + custom_templates
+      templates = all_files.delete_if {|file| custom_templates.include?(file + '.local')}
+      dotNetTemplates = dotNetTemplates.delete_if {|file| file.include?("/bin/")}
+      all_files + dotNetTemplates
+    end
+  end
+end

data/lib/dice_bag/railtie.rb

@@ -0,0 +1,7 @@
+module DiceBag
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require 'dice_bag/tasks'
+    end
+  end
+end

data/lib/dice_bag/tasks.rb

@@ -0,0 +1 @@
+load 'dice_bag/tasks/config.rake'

data/lib/dice_bag/tasks/config.rake

@@ -0,0 +1,31 @@
+require 'erb'
+require 'dice_bag/command'
+
+desc "Configure the application from the environment. It creates template files if you need and their config files"
+task :config => ['config:generate_all', 'config:all']
+
+namespace :config do
+  desc "Create all the files from their templates in config/"
+  task :all do
+    DiceBag::Command.new.write_all
+  end
+
+  desc "Recreate the file passed as parameter from its template"
+  task :file, :filename do |t, args|
+    filename = args[:filename]
+    raise "A filename needs to be provided" if filename.nil?
+    DiceBag::Command.new.write(filename)
+  end
+
+  desc "Generates all the template files needed by this project, named as the parameter."
+  task :generate_all do
+    DiceBag::Command.new.generate_all_templates
+  end
+
+  desc "Regenerate a given template"
+  task :generate, :filename do |t, args|
+    filename = args[:filename]
+    raise "A filename needs to be provided" if filename.nil?
+    DiceBag::Command.new.generate_template(filename)
+  end
+end

data/lib/dice_bag/template_file.rb

@@ -0,0 +1,39 @@
+require 'dice_bag/dice_bag_file.rb'
+require 'dice_bag/template_helpers'
+require 'dice_bag/configuration'
+require 'dice_bag/warning'
+
+#this class encapsulates the template files we will generate in the project 
+#using this gem
+module DiceBag
+
+  class TemplateFile
+    include DiceBagFile
+
+    # Methods from this module need to be called directly from within the ERB
+    # templates.
+    include DiceBag::TemplateHelpers
+
+    def initialize(name)
+      @filename = File.basename(name)
+      @file = name
+    end
+
+    def create_file(config_file)
+      # By passing "<>" we're trimming trailing newlines on lines that are
+      # nothing but ERB blocks (see documentation). This is useful for files
+      # like mauth_key where we want to control newlines carefully.
+      template = ERB.new(File.read(@file), nil, "<>")
+
+      #templates expect a configured object
+      configured = Configuration.new
+      warning = Warning.new(@filename)
+      contents = template.result(binding)
+
+      return unless config_file.should_write?(contents)
+      config_file.write(contents)
+      puts "file #{config_file.file} created"
+    end
+
+  end
+end

data/lib/dice_bag/template_helpers.rb

@@ -0,0 +1,8 @@
+module DiceBag
+  module TemplateHelpers
+    def generate_private_key
+      require 'openssl'
+      OpenSSL::PKey::RSA.generate(2048)
+    end
+  end
+end

data/lib/dice_bag/templates/aws.yml.erb

@@ -0,0 +1,11 @@
+<%= warning.as_yaml_comment %>
+
+development: &default
+  access_key_id: <%= configured.aws_access_key_id  %>
+  secret_access_key: <%= configured.aws_secret_access_key  %>
+
+test:
+  <<: *default
+  
+production:
+  <<: *default

data/lib/dice_bag/templates/dalli.yml.erb

@@ -0,0 +1,20 @@
+<%= warning.as_yaml_comment %>
+
+# This example file is intended to be used by a the developer who would like
+# use a locally running memcached.  By default, though, 
+# config/environments/development.rb sets the cache_store to memory
+# To enable this storage mechanism in development mode, consult the 
+# cache configuration code in config/environments/production.rb
+
+development: &default
+  namespace: PROJECT_NAME
+  host: localhost
+  port: 11211
+  value_max_bytes: 52428800
+  compress: true
+  
+test:
+  <<: *default
+
+production:
+  <<: *default

data/lib/dice_bag/templates/database.yml.erb

@@ -0,0 +1,16 @@
+<%= warning.as_yaml_comment %>
+
+<% [:development, :test, :production].each do |env| %>
+<%= env %>:
+  adapter: <%= configured[env].database_driver || 'mysql2' %>
+  database: <%= configured[env].database_name || "PROJECT_NAME_#{env}" %>
+  username: <%= configured[env].database_username || 'root' %>
+  password: <%= configured[env].database_password %>
+  host: <%= configured[env].database_host || 'localhost' %>
+  pool: 5
+  timeout: 5000
+  encoding: utf8
+  reconnect: false
+  <% db_cert = configured[env].database_ssl_cert %>
+  <%= db_cert ? "sslca: #{db_cert}" : '' %>
+<% end %>

data/lib/dice_bag/templates/gems_checker.rb

@@ -0,0 +1,44 @@
+# This module has the logic that decides what templates will be
+# generated for this project.
+# this file lives in the same directory than all the templates it
+# provides logic for.
+require 'dice_bag'
+
+module DiceBag
+  class CommonTemplatesBag < AvailableTemplates 
+    
+    def templates
+      @needed_templates = []
+      configured = Configuration.new
+
+      if defined?(Dalli)
+        add_template('dalli.yml.erb')
+      end
+
+      if defined?(Mysql2)
+        add_template('database.yml.erb')
+      end
+
+      if defined?(AWS)
+        add_template('aws.yml.erb')
+      end
+
+      if configured.google_analytics_id
+        add_template('google_analytics.yml.erb')
+      end
+
+      if defined?(NewRelic)
+        add_template('newrelic.yml.erb')
+      end
+
+      @needed_templates
+    end
+
+    def add_template(file)
+      pwd = File.dirname(__FILE__)
+      @needed_templates.push(File.join(pwd, file))
+    end 
+
+  end
+
+end

data/lib/dice_bag/templates/google_analytics.yml.erb

@@ -0,0 +1,5 @@
+<%= warning.as_yaml_comment %>
+
+<% if configured.google_analytics_id %>
+<%= "#{configured.rails_env}: #{configured.google_analytics_id}" %>
+<% end %>

data/lib/dice_bag/templates/newrelic.yml.erb

@@ -0,0 +1,37 @@
+<%= warning.as_yaml_comment %>
+
+common: &default_settings
+  license_key: <%= configured.newrelic_key || "12345" %>
+  app_name: <%= configured.domain || 'PROJECT_NAME' %>
+  enabled: <%= configured.enable_newrelic || false %>
+  log_level: <%= configured.new_relic_debug == 'true' ? 'debug' : 'info' %>
+  ssl: false
+  apdex_t: 0.5
+  capture_params: false
+  transaction_tracer:
+    enabled: true
+    transaction_threshold: apdex_f
+    record_sql: obfuscated
+    stack_trace_threshold: <%= configured.new_relic_debug == 'true' ? '0.1' : '0.5' %>
+  error_collector:
+    enabled: true
+    capture_source: true
+    ignore_errors: ActionController::RoutingError
+  background:
+    monitor_mode: true
+    app_name: <%= configured.domain || 'PROJECT_NAME' %>
+
+development:
+  <<: *default_settings
+  enabled: false
+  developer: true
+
+test:
+  <<: *default_settings
+  enabled: false
+  developer: false
+
+production:
+  <<: *default_settings
+  enabled: true
+  developer: false

data/lib/dice_bag/version.rb

@@ -0,0 +1,3 @@
+module DiceBag
+  VERSION = '0.4.0'
+end

data/lib/dice_bag/warning.rb

@@ -0,0 +1,30 @@
+module DiceBag
+  class Warning
+
+    def initialize(template_filename)
+      @template_filename = template_filename
+    end
+
+    def as_ruby_comment
+      lines.map {|line| "# #{line}\n" }.join
+    end
+
+    alias :as_yaml_comment :as_ruby_comment
+
+    def as_xml_comment
+      ['<!--', lines, '-->'].flatten.join("\n")
+    end
+
+    protected
+
+    def lines
+      [
+        "WARNING! Do not modify this file directly. It was generated from the",
+        "'#@template_filename' template file.",
+        "",
+        "Use the rake config task to reconfigure. See the template file for",
+        "further guidance."
+      ]
+    end
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'dice_bag/project'
+
+describe DiceBag::Project do
+  let(:project) { DiceBag::Project }
+
+  describe "#name" do 
+    it "should give me a default name for non Rails apps" do
+      project.name.should == DiceBag::Project::DEFAULT_NAME
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'dice_bag'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: dice_bag
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &73429760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *73429760
+description: 
+email:
+- asmith@mdsol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dice_bag.rb
+- lib/dice_bag/warning.rb
+- lib/dice_bag/command.rb
+- lib/dice_bag/project.rb
+- lib/dice_bag/default_template_file.rb
+- lib/dice_bag/tasks.rb
+- lib/dice_bag/template_file.rb
+- lib/dice_bag/dice_bag_file.rb
+- lib/dice_bag/config_file.rb
+- lib/dice_bag/version.rb
+- lib/dice_bag/templates/newrelic.yml.erb
+- lib/dice_bag/templates/database.yml.erb
+- lib/dice_bag/templates/gems_checker.rb
+- lib/dice_bag/templates/google_analytics.yml.erb
+- lib/dice_bag/templates/dalli.yml.erb
+- lib/dice_bag/templates/aws.yml.erb
+- lib/dice_bag/railtie.rb
+- lib/dice_bag/configuration.rb
+- lib/dice_bag/tasks/config.rake
+- lib/dice_bag/available_templates.rb
+- lib/dice_bag/template_helpers.rb
+- spec/command_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mdsol/dice_bag
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Dice Bag is a library of rake tasks for configuring web apps in the style
+  of The Twelve-Factor App. It also provides continuous integration tasks that rely
+  on the configuration tasks.
+test_files:
+- spec/command_spec.rb
+- spec/spec_helper.rb