dm-cli 0.9.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Wayne E. Seguin
+
+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

@@ -0,0 +1,7 @@
+dm-cli
+======
+
+DataMapper plugin allowing interaction with models through a Command-Line
+Interface (CLI).
+
+For any issues or questions, in addition to tickets please contact wayneeseguin@gmail.com / wayneeseguin on irc.freenode.net.

data/Rakefile

@@ -0,0 +1,67 @@
+require "rubygems"
+require "spec"
+require "rake/clean"
+require "rake/gempackagetask"
+require "spec/rake/spectask"
+require "pathname"
+
+CLEAN.include "{log,pkg}/"
+
+spec = Gem::Specification.new do |s|
+  s.name             = "dm-cli"
+  s.version          = "0.9.2"
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README LICENSE TODO ]
+  s.summary          = "DataMapper plugin allowing interaction with models through a CLI"
+  s.description      = s.summary
+  s.author           = "Wayne E. Seguin"
+  s.email            = "wayneeseguin@gmail.com"
+  s.homepage         = "http://github.com/sam/dm-more/tree/master/dm-cli"
+  s.executables      = [ "dm" ]
+  s.bindir           = "bin"
+  s.require_path     = "lib"
+  s.files            = FileList[ "bin/.*", "{lib,spec}/**/*.rb", "spec/spec.opts", "Rakefile", *s.extra_rdoc_files ]
+  s.add_dependency("dm-core", "=#{s.version}")
+end
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? "" : ("sudo" unless ENV["SUDOLESS"])
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install #{spec.name} #{spec.version} (default ruby)"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+end
+
+desc "Uninstall #{spec.name} #{spec.version} (default ruby)"
+task :uninstall => [ :clobber ] do
+  sh "#{SUDO} gem uninstall #{spec.name} -v#{spec.version} -I -x", :verbose => false
+end
+
+namespace :jruby do
+  desc "Install #{spec.name} #{spec.version} with JRuby"
+  task :install => [ :package ] do
+    sh %{#{SUDO} jruby -S gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources}, :verbose => false
+  end
+end
+
+desc "Run specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << "--options" << "spec/spec.opts" if File.exists?("spec/spec.opts")
+  t.spec_files = Pathname.glob(Pathname.new(__FILE__).dirname + "spec/**/*_spec.rb")
+
+  begin
+    t.rcov = ENV.has_key?("NO_RCOV") ? ENV["NO_RCOV"] != "true" : true
+    t.rcov_opts << "--exclude" << "spec"
+    t.rcov_opts << "--text-summary"
+    t.rcov_opts << "--sort" << "coverage" << "--sort-reverse"
+  rescue Exception
+    # rcov not installed
+  end
+end

data/TODO

@@ -0,0 +1,8 @@
+TODO
+====
+
+
+
+---
+TODO tickets may also be found in the DataMapper Issue Tracker:
+http://wm.lighthouseapp.com/projects/4819-datamapper/overview

data/bin/.irbrc

@@ -0,0 +1,2 @@
+IRB.conf[:PROMPT] = {:DM => { :PROMPT_I=>"%03n:%i dm> ", :PROMPT_N=>"%03n:%i dm> ", :PROMPT_S=>"%03n:%i%l dm", :PROMPT_C=>"%03n:%i dm*", :RETURN=>"%s\n" }}
+IRB.conf[:PROMPT_MODE] = :DM

data/bin/dm

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require "rubygems"
+
+gem "dm-core", ">=0.9.2"
+require "dm-core"
+require "pathname"
+require Pathname("data_mapper/cli")
+require "optparse"
+
+DataMapper::CLI::BinDir = File.dirname(__FILE__)
+DataMapper::CLI.start

data/lib/data_mapper/cli.rb

@@ -0,0 +1,185 @@
+require "yaml"
+require "irb"
+require Pathname("irb/completion")
+
+# TODO: error handling for:
+#   missing adapter, host or database
+module DataMapper
+
+  class CLI
+
+    class << self
+
+      def usage
+        <<-USAGE
+
+dm - Data Mapper CLI
+
+  Usage Examples\n#{'='*80}
+
+* If exactly one argument is given the CLI assumes it is a connection string:
+  $ dm mysql://root@localhost/test_development
+
+  The connection string has the format:
+    adapter://user:password@host:port/database
+  Where adapter is in: {mysql, pgsql, sqlite...} and the user/password is optional
+
+* Load the database by specifying only cli options
+  $ dm -a mysql -u root -h localhost -d test_development -e developemnt
+
+* Load the database using a yaml config file and specifying the environment to use
+  $ dm --yaml config/database.yml -e development
+
+* Load everything from a config file, this example is equivalent to the above
+  $ dm --config config/development.yml
+
+* Load the database and some model files from a directory, specifying the environment
+  $ dm --yaml config/database.yml -e development --models app/models
+
+* Load an assumed structure of a typical merb application
+  $ dm --merb -e development
+
+  This is similar to merb -i without the merb framework being loaded.
+
+USAGE
+      end
+
+      attr_accessor :options, :config
+
+      def parse_args(argv = ARGV)
+        @config ||= {}
+
+        # Build a parser for the command line arguments
+        OptionParser.new do |opt|
+          opt.define_head "DataMapper CLI"
+          opt.banner = usage
+
+          opt.on("-m", "--models MODELS", "The directory to load models from.") do |models|
+            @config[:models] = Pathname(models)
+          end
+
+          opt.on("-c", "--config FILE", "Entire configuration structure, useful for testing scenarios.") do |config_file|
+            @config = YAML::load_file Pathname(config_file)
+          end
+
+          opt.on("--merb", "--rails", "Loads application settings: config/database.yml, app/models.") do
+            @config[:models] = Pathname("app/models")
+            @config[:yaml]   = Pathname("config/database.yml")
+          end
+
+          opt.on("-y", "--yaml YAML", "The database connection configuration yaml file.") do |yaml_file|
+            if (yaml = Pathname(yaml_file)).file?
+              @config[:yaml] = yaml
+            elsif (yaml = Pathname("#{Dir.getwd}/#{yaml_file}")).file?
+              @config[:yaml] = yaml
+            else
+              raise "yaml file was specifed as #{yaml_file} but does not exist."
+            end
+          end
+
+          opt.on("-l", "--log LOGFILE", "A string representing the logfile to use.") do |log_file|
+            @config[:log_file] = Pathname(log_file)
+          end
+
+          opt.on("-e", "--environment STRING", "Run merb in the correct mode(development, production, testing)") do |environment|
+            @config[:environment] = environment
+          end
+
+          opt.on("-a", "--adapter ADAPTER", "Number of merb daemons to run.") do |adapter|
+            @config[:adapter] = adapter
+          end
+
+          opt.on("-u", "--username USERNAME", "The user to connect to the database as.") do |username|
+            @config[:username] = username
+          end
+
+          opt.on("-p", "--password PASSWORD", "The password to connect to the database with") do |password|
+            @config[:password] = password
+          end
+
+          opt.on("-h", "--host HOSTNAME", "Host to connect to.") do |host|
+            @config[:host] = host
+          end
+
+          opt.on("-s", "--socket SOCKET", "The socket to connect to.") do |socket|
+            @config[:socket] = socket
+          end
+
+          opt.on("-o", "--port PORT", "The port to connect to.") do |port|
+            @config[:port] = port
+          end
+
+          opt.on("-d", "--database DATABASENAME", "Name of the database to connect to.") do |database_name|
+            @config[:database] = database_name
+          end
+
+          opt.on("-?", "-H", "--help", "Show this help message") do
+            puts opt
+            exit
+          end
+
+        end.parse!(argv)
+
+      end
+
+      def configure(args)
+        if args[0] && args[0].match(/^(.+):\/\/(?:(.*)(?::(.+))?@)?(.+)\/(.+)$/)
+          @options = {
+            :adapter  => $1,
+            :username => $2,
+            :password => $3,
+            :host     => $4,
+            :database => $5
+          }
+          @config = @options.merge(:connection_string => ARGV.shift)
+        else
+
+          parse_args(args)
+
+          @config[:environment] ||= "development"
+          if @config[:config]
+            @config.merge!(YAML::load_file(@config[:config]))
+            @options = @config[:options]
+          elsif @config[:yaml]
+            @config.merge!(YAML::load_file(@config[:yaml]))
+            @options = @config[@config[:environment]] || @config[@config[:environment].to_sym]
+            raise "Options for environment '#{@config[:environment]}' are missing." if @options.nil?
+          else
+            @options = {
+              :adapter  => @config[:adapter],
+              :username => @config[:username],
+              :password => @config[:password],
+              :host     => @config[:host],
+              :database => @config[:database]
+            }
+          end
+
+        end
+      end
+
+      def load_models
+        Pathname.glob("#{config[:models]}/**/*.rb") { |file| load file }
+      end
+
+      def start(argv = ARGV)
+        if (ARGV.nil? || ARGV.empty?)
+          puts DataMapper::CLI.usage
+          exit 1
+        end
+
+        begin
+          configure(argv)
+          DataMapper.setup(:default, options.dup)
+          load_models if config[:models]
+          puts "DataMapper has been loaded using the '#{options[:adapter] || options["adapter"]}' database '#{options[:database] || options["database"]}' on '#{options[:host] || options["host"]}' as '#{options[:username] || options["username"]}'"
+          ENV["IRBRC"] = DataMapper::CLI::BinDir + "/.irbrc" # Do not change this please. This should NOT be DataMapper.root
+          IRB.start
+        rescue => error
+          puts error.message
+          exit
+        end
+
+      end
+    end
+  end # module CLI
+end # module DataMapper

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/unit/cli_spec.rb

@@ -0,0 +1,128 @@
+require "rubygems"
+
+gem "dm-core", ">=0.9.2"
+require "dm-core"
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "data_mapper", "cli"))
+
+describe DataMapper::CLI do
+
+  describe "connection string" do
+  end
+
+  describe "CLI options" do
+
+    # Entire configuration structure, useful for testing scenarios.
+    describe "-c or --config" do
+      it "should load config file" do
+        pending
+#        arg = ["c"]
+#        cli = DataMapper::CLI.new
+#        cli.parse_args(arg)
+
+      end
+    end
+
+    describe "-m or --models" do
+      it "should set options[:models]" do
+        pending
+      end
+    end
+
+    # database connection configuration yaml file.
+    describe "-y or --yaml" do
+      it "should set options[:yaml]" do
+        pending
+      end
+    end
+
+    # logfile
+    describe "-l or --log" do
+      it "should set options[:log_file]" do
+        pending
+      end
+    end
+
+    # environment to use with database yaml file.
+    describe "-e, --environment" do
+      it "should set options[:environment]" do
+        pending
+      end
+    end
+
+    # Loads Merb app settings: config/database.yml, app/models
+    # Loads Rails app settings: config/database.yml, app/models
+    describe "--merb, --rails" do
+      it "should set options[:models]" do
+        pending
+      end
+
+      it "should set options[:yaml]" do
+        pending
+      end
+    end
+
+    describe "database options" do
+
+      # adapter {mysql, pgsql, etc...}
+      describe "-a, --adapter" do
+        it "should support mysql" do
+          pending
+        end
+
+        it "should support pgsql" do
+          pending
+        end
+
+        it "should support sqlite" do
+          pending
+        end
+      end
+
+      # database name
+      describe "-d, --database" do
+        it "should set options[:database]" do
+          pending
+        end
+      end
+
+      # user name
+      describe "-u, --username" do
+        it "should set options[:username]" do
+          pending
+        end
+      end
+
+      # password
+      describe "-p, --password" do
+        it "should set options[:password]" do
+          pending
+        end
+      end
+
+      # host
+      describe "-h, --host" do
+        it "should set options[:host]" do
+          pending
+        end
+      end
+
+      # socket
+      describe "-s, --socket" do
+        it "should set options[:socket]" do
+          pending
+        end
+      end
+
+      # port
+      describe "-o, --port" do
+        it "should set options[:port]" do
+          pending
+        end
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: dm-cli
+version: !ruby/object:Gem::Version 
+  version: 0.9.2
+platform: ruby
+authors: 
+- Wayne E. Seguin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-25 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: DataMapper plugin allowing interaction with models through a CLI
+email: wayneeseguin@gmail.com
+executables: 
+- dm
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- bin/.
+- bin/..
+- bin/.irbrc
+- lib/data_mapper/cli.rb
+- spec/unit/cli_spec.rb
+- spec/spec.opts
+- Rakefile
+- README
+- LICENSE
+- TODO
+has_rdoc: true
+homepage: http://github.com/sam/dm-more/tree/master/dm-cli
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: DataMapper plugin allowing interaction with models through a CLI
+test_files: []
+