Permalink
Browse files

Adding a proper README and gemspec

  • Loading branch information...
amfranz committed Nov 29, 2010
1 parent dd784d7 commit 7ab8173a9a591f85ef5fda4ff5cfb5bf81395a0a
Showing with 109 additions and 76 deletions.
  1. +0 −37 .gitignore
  2. +1 −1 LICENSE.txt
  3. 0 README
  4. +49 −0 README.mdown
  5. +0 −19 README.rdoc
  6. +5 −19 Rakefile
  7. +54 −0 capistrano_database_yml.gemspec
View
@@ -1,42 +1,5 @@
-# rcov generated
-coverage
-
-# rdoc generated
-rdoc
-
-# yard generated
-doc
-.yardoc
-
# bundler
.bundle
# jeweler generated
pkg
-
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
-#
-# * Create a file at ~/.gitignore
-# * Include files you want ignored
-# * Run: git config --global core.excludesfile ~/.gitignore
-#
-# After doing this, these files will be ignored in all your git projects,
-# saving you from having to 'pollute' every project you touch with them
-#
-# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
-#
-# For MacOS:
-#
-#.DS_Store
-#
-# For TextMate
-#*.tmproj
-#tmtags
-#
-# For emacs:
-#*~
-#\#*
-#.\#*
-#
-# For vim:
-#*.swp
View
@@ -1,4 +1,4 @@
-Copyright (c) 2010 Michael Franz Aigner
+Copyright (c) 2010 Simone Carletti, Michael Franz Aigner
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
View
0 README
No changes.
View
@@ -0,0 +1,49 @@
+# Capistrano database.yml task
+
+Provides a couple of tasks for creating the database.yml
+configuration file dynamically when deploy:setup is run.
+
+## Source
+
+This is the database.yml task as introduced by Simone Carletti, packaged as a gem:
+
+http://www.simonecarletti.com/blog/2009/06/capistrano-and-database-yml/
+
+http://gist.github.com/2769
+
+## Usage
+
+The following assumes you use bundler. If you are working on a Rails 3 project, this should be the case.
+
+To use this gem, first add the following to your Gemfile:
+
+ gem "capistrano_database_yml"
+
+Then install the gem by executing:
+
+ $ bundle install
+
+Afterwards, add the following to your config/deploy.rb:
+
+ require "database_yml/capistrano"
+
+The original config/database.yml should be excluded from version control. You can easily accomplish this by renaming the file (for example to database.example.yml) and configuring your SCM in order to ignore the database.yml file.
+
+The following example demonstrate how to rename the file and ignore the original one with Subversion.
+
+ $ svn mv config/database.yml config/database.example.yml
+ $ svn propset svn:ignore 'database.yml' config
+
+If your repository is powered by Git, type the following commands.
+
+ $ git mv config/database.yml config/database.example.yml
+ $ echo 'config/database.yml' >> .gitignore
+
+## 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.
+
View
@@ -1,19 +0,0 @@
-= capistrano_database_yml
-
-Description goes here.
-
-== Contributing to capistrano_database_yml
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2010 Michael Franz Aigner. See LICENSE.txt for
-further details.
-
View
@@ -11,29 +11,15 @@ require 'rake'
require 'jeweler'
Jeweler::Tasks.new do |gem|
- # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
gem.name = "capistrano_database_yml"
gem.homepage = "http://github.com/amfranz/capistrano_database_yml"
gem.license = "MIT"
- gem.summary = %Q{TODO: one-line summary of your gem}
- gem.description = %Q{TODO: longer description of your gem}
+ gem.summary = %Q{Capistrano database.yml task}
+ gem.description = %Q{Provides a couple of tasks for creating the database.yml configuration file dynamically when deploy:setup is run.}
gem.email = "amfranz@gmail.com"
- gem.authors = ["Michael Franz Aigner"]
- # Include your dependencies below. Runtime dependencies are required when using your gem,
- # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
- # gem.add_runtime_dependency 'jabber4r', '> 0.1'
- # gem.add_development_dependency 'rspec', '> 1.2.3'
+ gem.authors = ["Michael Franz Aigner", "Simone Carletti"]
+ gem.add_runtime_dependency 'capistrano', '> 2.0'
end
Jeweler::RubygemsDotOrgTasks.new
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
- version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
- rdoc.rdoc_dir = 'rdoc'
- rdoc.title = "capistrano_database_yml #{version}"
- rdoc.rdoc_files.include('README*')
- rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task :default => :build
@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+ s.name = %q{capistrano_database_yml}
+ s.version = "1.0.0"
+
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+ s.authors = ["Michael Franz Aigner", "Simone Carletti"]
+ s.date = %q{2010-11-29}
+ s.description = %q{Provides a couple of tasks for creating the database.yml configuration file dynamically when deploy:setup is run.}
+ s.email = %q{amfranz@gmail.com}
+ s.extra_rdoc_files = [
+ "LICENSE.txt",
+ "README.mdown"
+ ]
+ s.files = [
+ ".document",
+ "Gemfile",
+ "Gemfile.lock",
+ "LICENSE.txt",
+ "README.mdown",
+ "Rakefile",
+ "VERSION",
+ "lib/database_yml/capistrano.rb"
+ ]
+ s.homepage = %q{http://github.com/amfranz/capistrano_database_yml}
+ s.licenses = ["MIT"]
+ s.require_paths = ["lib"]
+ s.rubygems_version = %q{1.3.7}
+ s.summary = %q{Capistrano database.yml task}
+
+ if s.respond_to? :specification_version then
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+ s.specification_version = 3
+
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+ s.add_runtime_dependency(%q<bundler>, ["~> 1.0.0"])
+ s.add_runtime_dependency(%q<jeweler>, ["~> 1.5.1"])
+ s.add_runtime_dependency(%q<capistrano>, ["> 2.0"])
+ else
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+ s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+ s.add_dependency(%q<capistrano>, ["> 2.0"])
+ end
+ else
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+ s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+ s.add_dependency(%q<capistrano>, ["> 2.0"])
+ end
+end
+

0 comments on commit 7ab8173

Please sign in to comment.