dm-is-reflective 0.8.0

data/lib/dm-is-reflective/is/adapters/postgres_adapter.rb

@@ -0,0 +1,84 @@
+
+require 'dm-is-reflective/is/adapters/abstract_adapter'
+
+module DataMapper
+  module Is::Reflective
+    module PostgresAdapter
+      def storages
+        sql = <<-SQL.compress_lines
+          SELECT table_name FROM "information_schema"."tables"
+          WHERE table_schema = current_schema()
+        SQL
+
+        query(sql)
+      end
+
+      private
+      def reflective_query_storage storage
+        sql = <<-SQL.compress_lines
+          SELECT column_name FROM "information_schema"."key_column_usage"
+          WHERE table_schema = current_schema() AND table_name = ?
+        SQL
+
+        keys = query(sql, storage).to_set
+
+        sql = <<-SQL.compress_lines
+          SELECT column_name, column_default, is_nullable,
+                 character_maximum_length, udt_name
+          FROM "information_schema"."columns"
+          WHERE table_schema = current_schema() AND table_name = ?
+        SQL
+
+        query(sql, storage).map{ |struct|
+          struct.instance_eval <<-END_EVAL
+            def key?
+              #{keys.member?(struct.column_name)}
+            end
+          END_EVAL
+          struct
+        }
+      end
+
+      def reflective_field_name field
+        field.column_name
+      end
+
+      def reflective_primitive field
+        field.udt_name
+      end
+
+      def reflective_attributes field, attrs = {}
+        # strip data type
+        field.column_default.gsub!(/(.*?)::[\w\s]*/, '\1') if field.column_default
+
+        attrs[:serial] = true if field.column_default =~ /nextval\('\w+'\)/
+        attrs[:key] = true if field.key?
+        attrs[:nullable] = field.is_nullable == 'YES'
+        # strip string quotation
+        attrs[:default] = field.column_default.gsub(/^'(.*?)'$/, '\1') if
+          field.column_default && !attrs[:serial]
+
+        if field.character_maximum_length
+          attrs[:length] = field.character_maximum_length
+        elsif field.udt_name.upcase == 'TEXT'
+          attrs[:length] = DataMapper::Types::Text.length
+        end
+
+        attrs
+      end
+
+      def reflective_lookup_primitive primitive
+        p = primitive.upcase
+
+        return Integer  if p =~ /^INT\d+$/
+        return String   if p == 'VARCHAR'
+        return DateTime if p == 'TIMESTAMP'
+        return DataMapper::Types::Text    if p == 'TEXT'
+        return DataMapper::Types::Boolean if p == 'BOOL'
+
+        super(primitive)
+      end
+
+    end
+  end
+end

data/lib/dm-is-reflective/is/adapters/sqlite3_adapter.rb

@@ -0,0 +1,61 @@
+
+require 'dm-is-reflective/is/adapters/abstract_adapter'
+
+module DataMapper
+  module Is::Reflective
+    module Sqlite3Adapter
+      def storages
+        sql = <<-SQL.compress_lines
+          SELECT name
+          FROM sqlite_master
+          WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+        SQL
+
+        query sql
+      end
+
+      private
+      # alias_method :reflective_query_storages, :query_table
+      def reflective_query_storage *args, &block
+        query_table(*args, &block)
+      end
+
+      def reflective_field_name field
+        field.name
+      end
+
+      def reflective_primitive field
+        field.type.gsub(/\(\d+\)/, '')
+      end
+
+      def reflective_attributes field, attrs = {}
+        if field.pk != 0
+          attrs[:key] = true
+          attrs[:serial] = true if supports_serial?
+        end
+        attrs[:nullable] = field.notnull != 1
+        attrs[:default] = field.dflt_value[1..-2] if field.dflt_value
+
+        if field.type.upcase == 'TEXT'
+          attrs[:length] = DataMapper::Types::Text.length
+        else
+          ergo = field.type.match(/\((\d+)\)/)
+          size = ergo && ergo[1].to_i
+          attrs[:length] = size if size
+        end
+
+        attrs
+      end
+
+      def reflective_lookup_primitive primitive
+        p = primitive.upcase
+
+        return Integer  if p =~ 'INTEGER'
+        return Float    if p == 'REAL' || p == 'NUMERIC'
+        return DataMapper::Types::Text if p == 'TEXT'
+
+        super(primitive)
+      end
+    end
+  end
+end

data/lib/dm-is-reflective/is/reflective.rb

@@ -0,0 +1,78 @@
+
+module DataMapper
+module Is
+module Reflective
+
+  def is_reflective
+    extend ClassMethod
+  end
+
+  module ClassMethod
+    # it simply calls Migration#fields(self.storage_name)
+    #  e.g.
+    #       DataMapper.repository.adapter.fields storage_name
+    def fields repo = default_repository_name
+      DataMapper.repository(repo).adapter.fields(storage_name(repo))
+    end
+
+    # it automaticly creates reflection from storage fields to properties.
+    # i.e. you don't have to specify any property if you are connecting
+    # to an existing database.
+    # you can pass it Regexp to map any field it matched, or just
+    # the field name in Symbol or String, or a Class telling it
+    # map any field which type equals to the Class.
+    # returned value is an array of properties indicating fields it mapped
+    #  e.g.
+    #       class User
+    #         include DataMapper::Resource
+    #         # reflect all
+    #         reflect /.*/  # e.g. => [#<Property:#<Class:0x18f89b8>:id>,
+    #                       #          #<Property:#<Class:0x18f89b8>:title>,
+    #                       #          #<Property:#<Class:0x18f89b8>:body>,
+    #                       #          #<Property:#<Class:0x18f89b8>:user_id>]
+    #
+    #         # reflect all (with no argument at all)
+    #         reflect
+    #
+    #         # reflect for field name ended with _at, and started with salt_
+    #         reflect /_at$/, /^salt_/
+    #
+    #         # reflect id and email
+    #         reflect :id, :email
+    #
+    #         # reflect all fields with type String, and id
+    #         reflect String, :id
+    #
+    #         # reflect login, and all fields with type Integer
+    #         reflect :login, Integer
+    #       end
+    def reflect *targets
+      targets << /.*/ if targets.empty?
+
+      fields.map{ |field|
+        name, type, attrs = field
+
+        reflected = targets.each{ |target|
+          case target
+            when Regexp;
+              break name if name.to_s =~ target
+
+            when Symbol, String;
+              break name if name == target.to_sym
+
+            when Class;
+              break name if type == target
+
+            else
+              raise ArgumentError.new("invalid argument: #{target.inspect}")
+          end
+        }
+
+        property(reflected, type, attrs) if reflected.kind_of?(Symbol)
+      }.compact
+    end
+  end # of ClassMethod
+
+end # of Reflective
+end # of Is
+end # of DataMapper

data/lib/dm-is-reflective/is/version.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  module Is
+    module Reflective
+      VERSION = '0.8.0'
+    end
+  end
+end

data/lib/dm-is-reflective/version.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  module Is
+    module Reflective
+      VERSION = '0.8.0'
+    end
+  end
+end

data/tasks/ann.rake

@@ -0,0 +1,80 @@
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  file PROJ.ann.file do
+    ann = PROJ.ann
+    puts "Generating #{ann.file}"
+    File.open(ann.file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      ann.paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts ann.text if ann.text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => ['ann:prereqs', PROJ.ann.file]
+
+  desc "Send an email announcement"
+  task :email => ['ann:prereqs', PROJ.ann.file] do
+    ann = PROJ.ann
+    from = ann.email[:from] || Array(PROJ.authors).first || PROJ.email
+    to   = Array(ann.email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+    rfc822msg << File.read(ann.file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      ann.email[key]
+    end
+
+    params[3] = PROJ.email if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann.file
+
+# EOF

data/tasks/bones.rake

@@ -0,0 +1,20 @@
+
+if HAVE_BONES
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if t.application.top_level_tasks.length == 2
+      t.application.top_level_tasks.pop
+    end
+
+    if atr then Bones::Debug.show_attr(PROJ, atr)
+    else Bones::Debug.show PROJ end
+  end
+
+end  # namespace :bones
+
+end  # HAVE_BONES
+
+# EOF

data/tasks/gem.rake

@@ -0,0 +1,201 @@
+
+require 'find'
+require 'rake/packagetask'
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
+
+module Bones
+class GemPackageTask < Rake::PackageTask
+  # Ruby GEM spec containing the metadata for this package.  The
+  # name, version and package_files are automatically determined
+  # from the GEM spec and don't need to be explicitly provided.
+  #
+  attr_accessor :gem_spec
+
+  # Tasks from the Bones gem directory
+  attr_reader :bones_files
+
+  # Create a GEM Package task library.  Automatically define the gem
+  # if a block is given.  If no block is supplied, then +define+
+  # needs to be called to define the task.
+  #
+  def initialize(gem_spec)
+    init(gem_spec)
+    yield self if block_given?
+    define if block_given?
+  end
+
+  # Initialization tasks without the "yield self" or define
+  # operations.
+  #
+  def init(gem)
+    super(gem.name, gem.version)
+    @gem_spec = gem
+    @package_files += gem_spec.files if gem_spec.files
+    @bones_files = []
+
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+    if !test(?e, local_setup)
+      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
+    end
+  end
+
+  # Create the Rake tasks and actions specified by this
+  # GemPackageTask.  (+define+ is automatically called if a block is
+  # given to +new+).
+  #
+  def define
+    super
+    task :prereqs
+    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
+    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
+      when_writing("Creating GEM") {
+        chdir(package_dir_path) do
+          Gem::Builder.new(gem_spec).build
+          verbose(true) {
+            mv gem_file, "../#{gem_file}"
+          }
+        end
+      }
+    end
+
+    file package_dir_path => bones_files do
+      mkdir_p package_dir rescue nil
+
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+
+      bones_files.each do |fn|
+        base_fn = File.join('tasks', File.basename(fn))
+        f = File.join(package_dir_path, base_fn)
+        fdir = File.dirname(f)
+        mkdir_p(fdir) if !File.exist?(fdir)
+        if File.directory?(fn)
+          mkdir_p(f)
+        else
+          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
+          safe_ln(fn, f)
+        end
+      end
+    end
+  end
+  
+  def gem_file
+    if @gem_spec.platform == Gem::Platform::RUBY
+      "#{package_name}.gem"
+    else
+      "#{package_name}-#{@gem_spec.platform}.gem"
+    end
+  end
+end  # class GemPackageTask
+end  # module Bones
+
+namespace :gem do
+
+  PROJ.gem._spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge.name
+
+    s.description = PROJ.description
+
+    PROJ.gem.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    PROJ.gem.development_dependencies.each do |dep|
+      s.add_development_dependency(*dep)
+    end
+
+    s.files = PROJ.gem.files
+    s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc.include.join('|'))
+    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.gem.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
+    else
+      s.test_files = PROJ.test.files.to_a
+    end
+
+    # Do any extra stuff the user wants
+    PROJ.gem.extras.each do |msg, val|
+      case val
+      when Proc
+        val.call(s.send(msg))
+      else
+        s.send "#{msg}=", val
+      end
+    end
+  end  # Gem::Specification.new
+
+  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+  end
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+
+  desc 'Write the gemspec '
+  task :spec => 'gem:prereqs' do
+    File.open("#{PROJ.name}.gemspec", 'w') do |f|
+      f.write PROJ.gem._spec.to_ruby
+    end
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, 'gem:package'] do
+    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
+
+    # use this version of the command for rubygems > 1.0.0
+    #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PROJ.name)
+    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
+      sh "#{SUDO} #{GEM} uninstall --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
+  desc 'Cleanup the gem'
+  task :cleanup do
+    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
+  end
+end  # namespace :gem
+
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+remove_desc_for_task 'gem:clobber_package'
+
+# EOF