dice_bag 0.4.1 → 0.5.0

data/lib/dice_bag/available_templates.rb

@@ -1,8 +1,19 @@
+require 'dice_bag/default_template_file'
+
 # This class returns all the templates we can generate in this particular project
 module DiceBag
  
   class AvailableTemplates
 
+
+    # By default the final location for any template will be the config directory.
+    # If any template 'plugin' wants to overwrite the directory where its template will be written
+    # it needs to overwrite this method and return a string with the new location as relative
+    # path inside the project.
+    def templates_location
+      Project.config_dir
+    end
+
     class << self
 
       def template_checkers
@@ -17,18 +28,20 @@ module DiceBag
         #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)
+        template_checkers.each do |template_checker|
+          checker = template_checker.new
+          location = checker.templates_location
+          checker.templates.each do |template|
+            available_templates.push( DefaultTemplateFile.new(template, location) )
           end
         end
         available_templates
       end
 
       def template_filename_for(filename)
-        self.all.each do |template_filename|
-          if template_filename.include? filename
-            return template_filename
+        self.all.each do |template|
+          if template.filename.include? filename
+            return template.file
           end
         end
       end

data/lib/dice_bag/command.rb

@@ -31,12 +31,9 @@ module DiceBag
       end
     end
 
-    def generate_template(file)
-      default_template = DefaultTemplateFile.new(file)
+    def generate_template(default_template)
       default_template.assert_existence
-      project_template = TemplateFile.new(File.basename(file))
-
-      default_template.create_file(project_template)
+      default_template.create_file
     end
 
   end

data/lib/dice_bag/config_file.rb

@@ -7,7 +7,9 @@ module DiceBag
   class ConfigFile
     include DiceBagFile
     def initialize(name)
-      @filename = name.gsub('.local', '').gsub('.erb', '').gsub('.template','')
+      # The 'local', 'erb', and 'template' file extension are deprecated and
+      # will be removed some time prior to v1.
+      @filename = name.gsub('.local', '').gsub('.erb', '').gsub('.template','').gsub('.dice', '')
       @file = Project.config_files(@filename)
     end
   end

data/lib/dice_bag/default_template_file.rb

@@ -9,19 +9,23 @@ module DiceBag
   class DefaultTemplateFile
     include DiceBagFile
 
-    def initialize(name)
+    def initialize(name, location=nil)
       #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
+      @template_location = location || Project.config_dir
     end
 
-    def create_file(template_file)
+    def create_file
       contents = read_template(@file)
-      template_file.write(contents)
-      puts "new template file generated in #{template_file.file}.
+      template_file = File.join(Project.root, @template_location, @filename)
+      File.open(template_file, 'w') do |file|
+        file.puts(contents)
+      end
+      puts "new template file generated in #{template_file}.
             execute 'rake config:all' to get the corresponding configuration file."
     end
 

data/lib/dice_bag/project.rb

@@ -10,21 +10,36 @@ module DiceBag
     end
 
     def self.config_files(filename)
-      File.join(self.config_dir, filename)
+      File.join(self.root, self.config_dir, filename)
     end
 
     # dotNet apps do not have the templates in config/ but in the root of the project
     # TODO: detect dotNet instead of detecting rails
     def self.config_dir
-      defined?(Rails) ? File.join(Dir.pwd, 'config') : Dir.pwd
+      defined?(Rails) ? 'config' : "."
+    end
+
+    def self.root
+      Dir.pwd
     end
 
     #local templates always takes preference over generated templates
     def self.templates_to_generate
+      dice_templates = Dir["**/*.dice"]
+
+      # The following ways of identifying template files will be removed prior
+      # to v1.
       generated_templates = Dir[Project.config_files("**/*.erb")]
       custom_templates = Dir[Project.config_files("**/*.erb.local")]
       dotNetTemplates = Dir[Project.config_files("**/*.config.template")]
-      all_files = generated_templates + custom_templates
+
+      legacy_files = generated_templates + custom_templates + dotNetTemplates
+      legacy_files.each do |file|
+        $stderr.puts "DEPRECATION WARNING: Use '.dice' file extension instead for '#{file}'"
+      end
+
+      all_files = legacy_files + dice_templates
+
       cleaned_templates = all_files.delete_if {|file| custom_templates.include?(file + '.local')}
       dotNetTemplates = dotNetTemplates.delete_if {|file| file.include?("/bin/")}
       (cleaned_templates + dotNetTemplates).map { |template| File.basename(template) }

data/lib/dice_bag/tasks/config.rake

@@ -2,7 +2,7 @@ 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']
+task :config => ['config:all']
 
 namespace :config do
   desc "Create all the files from their templates in config/"
@@ -22,10 +22,11 @@ namespace :config do
     DiceBag::Command.new.generate_all_templates
   end
 
-  desc "Regenerate a given template"
-  task :generate, :filename do |t, args|
+  desc "Regenerate a given template, params: filename of the template, location for the generated file[optional]"
+  task :generate, :filename, :location do |t, args|
     filename = args[:filename]
+    location = args[:location]
     raise "A filename needs to be provided" if filename.nil?
-    DiceBag::Command.new.generate_template(filename)
+    DiceBag::Command.new.generate_template(DiceBag::DefaultTemplateFile.new(filename,location))
   end
 end

data/lib/dice_bag/templates/{aws.yml.erb → aws.yml.dice}

@@ -6,6 +6,6 @@ development: &default
 
 test:
   <<: *default
-  
+
 production:
   <<: *default

data/lib/dice_bag/templates/{dalli.yml.erb → dalli.yml.dice}

@@ -12,7 +12,7 @@ development: &default
   port: 11211
   value_max_bytes: 52428800
   compress: true
-  
+
 test:
   <<: *default
 

data/lib/dice_bag/templates/gems_checker.rb

@@ -12,23 +12,23 @@ module DiceBag
       configured = Configuration.new
 
       if defined?(Dalli)
-        add_template('dalli.yml.erb')
+        add_template('dalli.yml.dice')
       end
 
       if defined?(Mysql2)
-        add_template('database.yml.erb')
+        add_template('database.yml.dice')
       end
 
       if defined?(AWS)
-        add_template('aws.yml.erb')
+        add_template('aws.yml.dice')
       end
 
       if configured.google_analytics_id
-        add_template('google_analytics.yml.erb')
+        add_template('google_analytics.yml.dice')
       end
 
       if defined?(NewRelic)
-        add_template('newrelic.yml.erb')
+        add_template('newrelic.yml.dice')
       end
 
       @needed_templates

data/lib/dice_bag/version.rb

@@ -1,3 +1,3 @@
 module DiceBag
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,30 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: dice_bag
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
 - Andrew Smith
+- Jordi Carres
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-21 00:00:00.000000000Z
+date: 2013-02-27 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &72996330 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *72996330
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &74949160 !ruby/object:Gem::Requirement
+  requirement: &72996080 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *74949160
+  version_requirements: *72996080
 description: 
 email:
 - asmith@mdsol.com
+- jcarres@mdsol.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -39,12 +52,12 @@ files:
 - 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/dalli.yml.dice
+- lib/dice_bag/templates/database.yml.dice
 - 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/templates/newrelic.yml.dice
+- lib/dice_bag/templates/google_analytics.yml.dice
+- lib/dice_bag/templates/aws.yml.dice
 - lib/dice_bag/railtie.rb
 - lib/dice_bag/configuration.rb
 - lib/dice_bag/tasks/config.rake