geminstaller_builder 0.1.0 → 0.1.1

data/.gitignore

@@ -17,5 +17,6 @@ tmtags
 coverage
 rdoc
 pkg
+tmp
 
 ## PROJECT::SPECIFIC

data/README.md

@@ -0,0 +1,105 @@
+# geminstaller_builder
+
+A simple tool for generating valid and up-to-date geminstaller files. Bundler
+is probably what you want, but if you're supporting legacy apps or you just
+like geminstaller, this could be helpful.
+
+# Use
+
+## Solo
+
+    require 'geminstaller_builder'
+    geminstaller = GeminstallerBuilder.new
+    geminstaller.add 'haml'
+    geminstaller.add 'state_machine'
+    geminstaller.add 'shoulda', :test
+    geminstaller.save
+
+Will create two files:
+
+`config/geminstaller.yml`:
+
+    ---
+    defaults:
+      install-options: '--no-rdoc --no-ri'
+    gems:
+    - name: haml
+      version: '= 2.2.22'
+    - name: state_machine
+      version: '= 0.8.1'
+
+`config/test/geminstaller.yml`:
+
+    ---
+    defaults:
+      install-options: '--no-rdoc --no-ri'
+    gems:
+    - name: shoulda
+      version: '= 2.10.3'
+
+relative to the directory from which the script was run.
+
+By default, the `:default` and `:test` environments are assumed. To change the names of the files generated, pass in a `:paths` option with the full filenames. For example:
+
+    require 'geminstaller_builder'
+    geminstaller = GeminstallerBuilder.new :paths => {:default => 'geminstaller.yml', :test => 'geminstaller-test.yml'}
+    geminstaller.add 'haml'
+    geminstaller.add 'state_machine'
+    geminstaller.add 'shoulda', :test
+    geminstaller.save
+
+will create `geminstaller.yml` and `geminstaller-test.yml`.
+
+## In a Rails application template
+
+Looks pretty much the same. I use it like this:
+
+`template.rb`:
+
+    # use geminstaller instead of gem
+    require 'geminstaller_builder'
+    @geminstaller = GeminstallerFile.new
+    def geminstaller s, env=:default
+      @geminstaller.add s, env
+    end
+
+    # later on ...
+    geminstaller 'will_paginate'
+    geminstaller 'hpricot'
+    geminstaller 'json'
+    geminstaller 'state_machine'
+    geminstaller 'paperclip'
+
+    load_template 'http://github.com/smartlogic/rails-templates/raw/master/test.rb'
+
+and in `test.rb`:
+
+    geminstaller 'factory_girl', :test
+    geminstaller 'shoulda', :test
+    geminstaller 'redgreen', :test
+    geminstaller 'timecop', :test
+    geminstaller 'hydra', :test
+    geminstaller 'mocha', :test
+
+    # etc...
+
+Finally, at the end of `template.rb`, I have:
+
+    @geminstaller.save
+
+at which point, geminstaller_build consults the currently available gems to build the appropriate geminstaller.yml files.
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally. But then, I haven't included any
+  tests. So do what feels good.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Adam Bachman. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/geminstaller_builder.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geminstaller_builder}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Bachman"]
@@ -14,19 +14,18 @@ Gem::Specification.new do |s|
   s.email = %q{adam.bachman@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "geminstaller_builder.gemspec",
      "lib/geminstaller_builder.rb",
      "lib/geminstaller_builder/gem_helper.rb",
-     "lib/geminstaller_builder/geminstaller_file.rb",
      "test/helper.rb",
      "test/test_geminstaller_builder.rb"
   ]

data/lib/geminstaller_builder.rb

@@ -1,3 +1,39 @@
-require 'geminstaller_builder/geminstaller_file'
+require 'geminstaller_builder/gem_helper'
+
+# Convert a list of gems into a valid geminstaller.yml file.
 class GeminstallerBuilder
+  include GemHelper
+
+  def initialize options={}
+    options = {
+      :env => :default,
+      :gems => {
+        :default    => [],
+        :test       => []
+      },
+      :paths => {
+        :default    => "config/geminstaller.yml",
+        :test       => "config/test/geminstaller.yml"
+    }
+    }.merge(options)
+
+    @gems  = options[:gems]
+    @paths = options[:paths]
+  end
+
+  def add gem, env=:default
+    @gems[env.to_sym] << gem
+  end
+
+  alias_method :<<, :add
+
+  def save
+    puts "\e[34m[ Saving Gems ]\e[0m"
+    @gems.keys.each do |env|
+      File.open(@paths[env], 'w') do |f|
+        yaml_gems = @gems[env].map {|_g| gem_to_yaml(_g)}
+        f.write "---\ndefaults:\n  install-options: '--no-rdoc --no-ri'\ngems:\n" + yaml_gems.join("\n")
+      end
+    end
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Adam Bachman
@@ -37,18 +37,17 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - geminstaller_builder.gemspec
 - lib/geminstaller_builder.rb
 - lib/geminstaller_builder/gem_helper.rb
-- lib/geminstaller_builder/geminstaller_file.rb
 - test/helper.rb
 - test/test_geminstaller_builder.rb
 has_rdoc: true

data/README.rdoc

@@ -1,17 +0,0 @@
-= geminstaller-builder
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Adam Bachman. See LICENSE for details.

data/lib/geminstaller_builder/geminstaller_file.rb

@@ -1,38 +0,0 @@
-require 'geminstaller_builder/gem_helper'
-
-# Convert a list of gems into a valid geminstaller.yml file.
-class GeminstallerFile
-  include GemHelper
-  def initialize options={}
-    options = {
-      :env => :default,
-      :gems => {
-        :default    => [],
-        :test       => []
-      },
-      :paths => {
-        :default    => "config/geminstaller.yml",
-        :test       => "config/test/geminstaller.yml"
-    }
-    }.merge(options)
-
-    @gems  = options[:gems]
-    @paths = options[:paths]
-  end
-
-  def add gem, env=:default
-    @gems[env.to_sym] << gem
-  end
-
-  alias_method :<<, :add
-
-  def save
-    puts "\e[34m[ Saving Gems ]\e[0m"
-    @gems.keys.each do |env|
-      File.open(@paths[env], 'w') do |f|
-        yaml_gems = @gems[env].map {|_g| gem_to_yaml(_g)}
-        f.write "---\ndefaults:\n  install-options: '--no-rdoc --no-ri'\ngems:\n" + yaml_gems.join("\n")
-      end
-    end
-  end
-end