namelessjon-dm-gen 0.1.0 → 0.2.0

data/lib/dm_gen.rb

@@ -21,3 +21,4 @@ dir = File.join(File.dirname(__FILE__), 'generators')
 
 require File.join(dir, 'one_file')
 require File.join(dir, 'is')
+require File.join(dir, 'adapter')

data/lib/generators/adapter.rb

@@ -0,0 +1,54 @@
+module DMGen
+  class Adapter < Templater::Generator
+    first_argument :name, :required => true
+
+    desc <<-eos
+      Generates a DataMapper Adapter skeleton.
+
+      Use like
+        dm-gen adapter data_source
+
+      This generates the full plugin structure with skeleton code and specs, as
+      well as a Rakefile.  All it needs is a README and some real functionality.
+    eos
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), '..', 'templates', 'adapter')
+    end
+
+    def gem_name
+      "dm-#{adapter_name}"
+    end
+
+    def adapter_name
+      "#{snake_name}-adapter"
+    end
+
+    def adapter_file
+      "#{snake_name}_adapter"
+    end
+
+    def snake_name
+      name.snake_case
+    end
+
+    def class_name
+      "#{name.camel_case}Adapter"
+    end
+
+    def destination_root
+      File.join(@destination_root, gem_name)
+    end
+
+    # glob the template dir for all templates.
+    # since we want text files processed, we have to replace the default
+    # extension list.
+    glob!('', %w[rb txt Rakefile LICENSE TODO])
+
+    def manifest_files
+      self.all_actions.map {|t| t.destination.gsub(/#{destination_root}\//,'') }.sort
+    end
+  end
+
+  add :adapter, Adapter
+end

data/lib/templates/adapter/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 / <%= Time.now.strftime('%Y-%m-%d') %>
+
+* Release!
+

data/lib/templates/adapter/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Doe
+
+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/lib/templates/adapter/Manifest.txt

@@ -0,0 +1 @@
+<%= manifest_files.join("\n") %>

data/lib/templates/adapter/README.txt

@@ -0,0 +1,3 @@
+= <%= gem_name %>
+
+Description of the adapter.  What data-store is it for, what is that good for?

data/lib/templates/adapter/Rakefile

@@ -0,0 +1,30 @@
+require 'pathname'
+require 'rubygems'
+require 'hoe'
+
+ROOT    = Pathname(__FILE__).dirname.expand_path
+JRUBY   = RUBY_PLATFORM =~ /java/
+WINDOWS = Gem.win_platform?
+SUDO    = (WINDOWS || JRUBY) ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+require ROOT + 'lib/<%= adapter_file %>/version'
+
+# define some constants to help with task files
+GEM_NAME    = '<%= gem_name %>'
+GEM_VERSION = DataMapper::<%= class_name %>::VERSION
+
+Hoe.new(GEM_NAME, GEM_VERSION) do |p|
+  p.developer('John Doe', 'john [a] doe [d] com')
+
+  p.description = 'A DataMapper Adapter for ...'
+  p.summary = 'A DataMapper Adapter for ...'
+  p.url = 'http://github.com/USERNAME/<%= gem_name %>'
+
+  p.clean_globs |= %w[ log pkg coverage ]
+  p.spec_extras = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO History.txt ] }
+
+  p.extra_deps << [['dm-core', "~> 0.9.10"]]
+
+end
+
+Pathname.glob(ROOT.join('tasks/**/*.rb').to_s).each { |f| require f }

data/lib/templates/adapter/lib/%adapter_file%/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  module <%= class_name %>
+    VERSION = '0.0.1'
+  end
+end

data/lib/templates/adapter/lib/%adapter_file%.rb

@@ -0,0 +1,121 @@
+gem 'dm-core', '~>0.9.10'
+require 'dm-core'
+
+module DataMapper
+  module Adapters
+    # The documentation for this adapter was taken from
+    #
+    # lib/dm-core/adapters/in_memory_adapter.rb
+    #
+    # Which is intended as a general source of documentation for the
+    # implementation to be followed by all DataMapper adapters.  The implementor
+    # is well advised to read over the adapter before implementing their own.
+    #
+    class <%= class_name %> < AbstractAdapter
+      ##
+      # Used by DataMapper to put records into a data-store: "INSERT" in SQL-speak.
+      # It takes an array of the resources (model instances) to be saved. Resources
+      # each have a key that can be used to quickly look them up later without
+      # searching, if the adapter supports it.
+      #
+      # @param [Array<DataMapper::Resource>] resources
+      #   The set of resources (model instances)
+      #
+      # @return [Integer]
+      #   The number of records that were actually saved into the data-store
+      #
+      # @api semipublic
+      def create(resources)
+        raise NotImplementedError
+      end
+
+      ##
+      # Used by DataMapper to update the attributes on existing records in a
+      # data-store: "UPDATE" in SQL-speak. It takes a hash of the attributes
+      # to update with, as well as a query object that specifies which resources
+      # should be updated.
+      #
+      # @param [Hash] attributes
+      #   A set of key-value pairs of the attributes to update the resources with.
+      # @param [DataMapper::Query] query
+      #   The query that should be used to find the resource(s) to update.
+      #
+      # @return [Integer]
+      #   the number of records that were successfully updated
+      #
+      # @api semipublic
+      def update(attributes, query)
+        raise NotImplementedError
+      end
+
+      ##
+      # Look up a single record from the data-store. "SELECT ... LIMIT 1" in SQL.
+      # Used by Model#get to find a record by its identifier(s), and Model#first
+      # to find a single record by some search query.
+      #
+      # @param [DataMapper::Query] query
+      #   The query to be used to locate the resource.
+      #
+      # @return [DataMapper::Resource]
+      #   A Resource object representing the record that was found, or nil for no
+      #   matching records.
+      #
+      # @api semipublic
+      def read_one(query)
+        raise NotImplementedError
+      end
+
+      ##
+      # Looks up a collection of records from the data-store: "SELECT" in SQL.
+      # Used by Model#all to search for a set of records; that set is in a
+      # DataMapper::Collection object.
+      #
+      # @param [DataMapper::Query] query
+      #   The query to be used to seach for the resources
+      #
+      # @return [DataMapper::Collection]
+      #   A collection of all the resources found by the query.
+      #
+      # @api semipublic
+      def read_many(query)
+        raise NotImplementedError
+      end
+
+      ##
+      # Destroys all the records matching the given query. "DELETE" in SQL.
+      #
+      # @param [DataMapper::Query] query
+      #   The query used to locate the resources to be deleted.
+      #
+      # @return [Integer]
+      #   The number of records that were deleted.
+      #
+      # @api semipublic
+      def delete(query)
+        raise NotImplementedError
+      end
+
+      private
+
+      ##
+      # Make a new instance of the adapter. The @model_records ivar is the 'data-store'
+      # for this adapter. It is not shared amongst multiple incarnations of this
+      # adapter, eg DataMapper.setup(:default, :adapter => :in_memory);
+      # DataMapper.setup(:alternate, :adapter => :in_memory) do not share the
+      # data-store between them.
+      #
+      # @param [String, Symbol] name
+      #   The name of the DataMapper::Repository using this adapter.
+      # @param [String, Hash] uri_or_options
+      #   The connection uri string, or a hash of options to set up
+      #   the adapter
+      #
+      # @api semipublic
+      def initialize(name, uri_or_options)
+        super
+        @identity_maps = {}
+      end
+
+    end
+  end
+end

data/lib/templates/adapter/spec/integration/%adapter_file%_spec.rb

@@ -0,0 +1,6 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe 'DataMapper::Adapters::<%= class_name %>' do
+
+end

data/lib/templates/adapter/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/lib/templates/adapter/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'pathname'
+require 'rubygems'
+
+gem 'rspec', '~>1.1.11'
+require 'spec'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/<%= adapter_file %>'
+
+DataMapper.setup(:default, "<%= name %>://some/uri/here")
+

data/lib/templates/adapter/tasks/install.rb

@@ -0,0 +1,13 @@
+def sudo_gem(cmd)
+  sh "#{SUDO} #{RUBY} -S gem #{cmd}", :verbose => false
+end
+
+desc "Install #{GEM_NAME} #{GEM_VERSION}"
+task :install => [ :package ] do
+  sudo_gem "install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
+end
+
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION}"
+task :uninstall => [ :clobber ] do
+  sudo_gem "uninstall #{GEM_NAME} -v#{GEM_VERSION} -Ix"
+end

data/lib/templates/adapter/tasks/spec.rb

@@ -0,0 +1,25 @@
+begin
+  gem 'rspec', '~>1.1.11'
+  require 'spec'
+  require 'spec/rake/spectask'
+
+  task :default => [ :spec ]
+
+  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((ROOT + 'spec/**/*_spec.rb').to_s)
+
+    begin
+      gem 'rcov', '~>0.8'
+      t.rcov = JRUBY ? false : (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 LoadError
+      # rcov not installed
+    end
+  end
+rescue LoadError
+  # rspec not installed
+end

data/spec/adapter_spec.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "DMGen::Adapter" do
+  before do
+    @generator = DMGen::Adapter.new('/tmp', {}, 'awesome')
+  end
+
+  # basic file creation.
+  it "creates a Rakefile" do
+    @generator.should create('/tmp/dm-awesome-adapter/Rakefile')
+  end
+  it "creates the lib folder layout" do
+    @generator.should create('/tmp/dm-awesome-adapter/lib/awesome_adapter.rb')
+    @generator.should create('/tmp/dm-awesome-adapter/lib/awesome_adapter/version.rb')
+  end
+  it "creates the spec folder layout" do
+    @generator.should create('/tmp/dm-awesome-adapter/spec/integration/awesome_adapter_spec.rb')
+    @generator.should create('/tmp/dm-awesome-adapter/spec/spec.opts')
+    @generator.should create('/tmp/dm-awesome-adapter/spec/spec_helper.rb')
+  end
+  it "creates a README" do
+    @generator.should create('/tmp/dm-awesome-adapter/README.txt')
+  end
+  it "creates a History file" do
+    @generator.should create('/tmp/dm-awesome-adapter/History.txt')
+  end
+  it "creates a LICENSE" do
+    @generator.should create('/tmp/dm-awesome-adapter/LICENSE')
+  end
+  it "creates a Manifest for Hoe" do
+    @generator.should create('/tmp/dm-awesome-adapter/Manifest.txt')
+  end
+  it "creates a TODO list" do
+    @generator.should create('/tmp/dm-awesome-adapter/TODO')
+  end
+  it "creates support tasks" do
+    @generator.should create('/tmp/dm-awesome-adapter/tasks/spec.rb')
+    @generator.should create('/tmp/dm-awesome-adapter/tasks/install.rb')
+  end
+
+  describe "Manifest.txt" do
+    before do
+      @template = @generator.template(:manifest_txt)
+      @result = @template.render
+    end
+
+    it "contains itself" do
+      @result.should.be.a.match(/^Manifest.txt$/)
+    end
+
+  end
+
+  describe "version.rb" do
+    before do
+      @template = @generator.template(:lib_adapter_file_version_rb)
+      @result = @template.render
+    end
+
+    it "generates the correct output" do
+      @result.should.include(<<-eos)
+module DataMapper
+  module AwesomeAdapter
+    VERSION = '0.0.1'
+  end
+end
+eos
+    end
+  end
+
+  describe "spec/spec_helper.rb" do
+    before do
+      @template = @generator.template(:spec_spec_helper_rb)
+      @result = @template.render
+    end
+
+    it "contains a connection string for the new adapter" do
+      @result.should.include('DataMapper.setup(:default, "awesome://some/uri/here")')
+    end
+
+    it "requires the adapter library" do
+      @result.should.be.a.match(/require .*lib\/awesome_adapter/)
+    end
+
+  end
+
+  describe "Rakefile" do
+    before do
+      @template = @generator.template(:rakefile)
+      @result = @template.render
+    end
+
+    it "requires the version file" do
+      @result.should.include(%q{require ROOT + 'lib/awesome_adapter/version'})
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: namelessjon-dm-gen
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jonathan Stott
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-20 00:00:00 -08:00
+date: 2009-01-21 00:00:00 -08:00
 default_executable: dm-gen
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,14 +55,35 @@ files:
 - lib/templates/is/tasks
 - lib/templates/is/tasks/install.rb
 - lib/templates/is/tasks/spec.rb
+- lib/templates/adapter
+- lib/templates/adapter/History.txt
+- lib/templates/adapter/LICENSE
+- lib/templates/adapter/Manifest.txt
+- lib/templates/adapter/README.txt
+- lib/templates/adapter/Rakefile
+- lib/templates/adapter/TODO
+- lib/templates/adapter/lib
+- lib/templates/adapter/lib/%adapter_file%.rb
+- lib/templates/adapter/lib/%adapter_file%
+- lib/templates/adapter/lib/%adapter_file%/version.rb
+- lib/templates/adapter/spec
+- lib/templates/adapter/spec/integration
+- lib/templates/adapter/spec/integration/%adapter_file%_spec.rb
+- lib/templates/adapter/spec/spec.opts
+- lib/templates/adapter/spec/spec_helper.rb
+- lib/templates/adapter/tasks
+- lib/templates/adapter/tasks/install.rb
+- lib/templates/adapter/tasks/spec.rb
 - lib/generators
 - lib/generators/one_file.rb
 - lib/generators/is.rb
+- lib/generators/adapter.rb
 - lib/dm_gen.rb
 - spec/dm_gen_spec.rb
 - spec/spec_helper.rb
 - spec/one_file_spec.rb
 - spec/is_plugin_spec.rb
+- spec/adapter_spec.rb
 has_rdoc: true
 homepage: http://github.com/namelessjon/dm-gen
 post_install_message: