jchris-couchrest 0.9.2 → 0.9.3

data/bin/couchview

@@ -1,111 +1,50 @@
 #!/usr/bin/env ruby
 
-commands = %w{push generate}
-
-command = ARGV[0]
-
-if !commands.include?(command)
-  puts <<-USAGE
-Couchview has two modes: push and generate. Run couchview push or couchview generate for usage documentation.  
-USAGE
-  exit
+require 'optparse'
+require File.dirname(__FILE__) + "/../lib/couch_rest/commands"
+
+# Set defaults
+options = {
+  :loud => true,
+}
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: #$0 [options] (push|generate) directory database"
+  opts.on('-q', '--quiet', "Omit extra debug info") do
+    options[:loud] = false
+  end
+  opts.on_tail('-h', '--help [push|generate]', "Display detailed help and exit") do |help_command|
+    puts opts
+    case help_command
+    when "push"
+      puts CouchRest::Commands::Push.help
+    when "generate"
+      puts CouchRest::Commands::Generate.help
+    end
+    exit
+  end
 end
+opts.parse!(ARGV)
 
-if ARGV.length == 1
-  case command
-  when "generate"
-    puts <<-GEN
-Usage: couchview generate directory design1 design2 design3 ...
-
-Couchview will create directories and example views for the design documents you specify.  
-  
-GEN
-  when "push"
-    puts <<-PUSH
-== Pushing views with Couchview ==
-
-Usage: couchview push directory dbname
-
-Couchview expects a specific filesystem layout for your CouchDB views (see
-example below). It also supports advanced features like inlining of library
-code (so you can keep DRY) as well as avoiding unnecessary document
-modification.
-
-Couchview also solves a problem with CouchDB's view API, which only provides
-access to the final reduce side of any views which have both a map and a
-reduce function defined. The intermediate map results are often useful for
-development and production. CouchDB is smart enough to reuse map indexes for
-functions duplicated across views within the same design document.
-
-For views with a reduce function defined, Couchview creates both a reduce view
-and a map-only view, so that you can browse and query the map side as well as
-the reduction, with no performance penalty.
-
-== Example ==
-
-couchview push foo-project/bar-views baz-database
+options[:command]       = ARGV.shift
+options[:directory]     = ARGV.shift
+options[:trailing_args] = ARGV
 
-This will push the views defined in foo-project/bar-views into a database
-called baz-database. Couchview expects the views to be defined in files with
-names like:
-
-foo-project/bar-views/my-design/viewname-map.js
-foo-project/bar-views/my-design/viewname-reduce.js
-foo-project/bar-views/my-design/noreduce-map.js
-
-Pushed to => http://localhost:5984/baz-database/_design/my-design
-
-And the design document:  
-    {
-      "views" : {
-        "viewname-map" : {
-          "map" : "### contents of view-name-map.js ###"
-        },
-        "viewname-reduce" : {
-          "map" : "### contents of view-name-map.js ###",
-          "reduce" : "### contents of view-name-reduce.js ###"
-        },
-        "noreduce-map" : {
-          "map" : "### contents of noreduce-map.js ###"
-        }
-      }
-    }
-
-Couchview will create a design document for each subdirectory of the views
-directory specified on the command line.
-
-== Library Inlining == 
-
-Couchview can optionally inline library code into your views so you only have
-to maintain it in one place. It looks for any files named lib.* in your
-design-doc directory (for doc specific libs) and in the parent views directory
-(for project global libs). These libraries are only inserted into views which
-include the text
-
-//include-lib
-
-or
-
-#include-lib
-
-Couchview is a result of scratching my own itch. I'd be happy to make it more
-general, so please contact me at jchris@grabb.it if you'd like to see anything
-added or changed.
-PUSH
-  end
+# There must be a better way to check for extra required args
+unless (["push", "generate"].include?(options[:command]) && options[:directory] && options[:trailing_args])
+  puts(opts)
   exit
 end
 
-require 'rubygems'
-require 'couchrest'
+# The options hash now contains the resolved defaults 
+# and the overrides from the command line.
+
+# Call your class and send it the options here
+# cr = CouchRest::FileManager.new(options[:database_name])
 
-if command == 'push'
-  dirname = ARGV[1]
-  dbname = ARGV[2]
-  fm = CouchRest::FileManager.new(dbname)
-  fm.loud = true
-  puts "Pushing views from directory #{dirname} to database #{fm.db}"
-  fm.push_views(dirname)
-elsif command == 'generate'
-  puts "Under construction ;)"
+case options[:command]
+when "push"
+  CouchRest::Commands::Push.run(options)
+when "generate"
+  CouchRest::Commands::Generate.run(options)
 end

data/lib/couch_rest.rb

@@ -35,7 +35,7 @@ class CouchRest
   
   # creates the database if it doesn't exist
   def database! name
-    create_db(path) rescue nil
+    create_db(name) rescue nil
     database name
   end
   

data/lib/couch_rest/commands.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), "..", "couchrest")
+  
+%w(push generate).each do |filename|
+  require File.join(File.dirname(__FILE__), "commands", filename)
+end

data/lib/couch_rest/commands/generate.rb

@@ -0,0 +1,71 @@
+require 'fileutils'
+
+class CouchRest
+  module Commands
+    module Generate
+
+      def self.run(options)
+        directory    = options[:directory]
+        design_names = options[:trailing_args]
+
+        FileUtils.mkdir_p(directory)
+        filename = File.join(directory, "lib.js")
+        self.write(filename, <<-FUNC)
+        // Put global functions here.
+        // Include in your views with
+        //
+        //   //include-lib
+        FUNC
+
+        design_names.each do |design_name|
+          subdirectory = File.join(directory, design_name)
+          FileUtils.mkdir_p(subdirectory)
+          filename = File.join(subdirectory, "sample-map.js")
+          self.write(filename, <<-FUNC)
+          function(doc) {
+            // Keys is first letter of _id
+            emit(doc._id[0], doc);
+          }
+          FUNC
+
+          filename = File.join(subdirectory, "sample-reduce.js")
+          self.write(filename, <<-FUNC)
+          function(keys, values) {
+            // Count the number of keys starting with this letter
+            return values.length;
+          }
+          FUNC
+
+          filename = File.join(subdirectory, "lib.js")
+          self.write(filename, <<-FUNC)
+          // Put functions specific to '#{design_name}' here.
+          // Include in your views with
+          //
+          //   //include-lib
+          FUNC
+        end
+      end
+
+      def self.help
+        helpstring = <<-GEN
+
+        Usage: couchview generate directory design1 design2 design3 ...
+
+        Couchview will create directories and example views for the design documents you specify.
+
+        GEN
+        helpstring.gsub(/^        /, '')
+      end
+
+      def self.write(filename, contents)
+        puts "Writing #{filename}"
+        File.open(filename, "w") do |f|
+          # Remove leading spaces
+          contents.gsub!(/^        (  )?/, '')
+          f.write contents
+        end
+      end
+
+    end
+  end
+end

data/lib/couch_rest/commands/push.rb

@@ -0,0 +1,99 @@
+class CouchRest
+
+  module Commands
+
+    module Push
+
+      def self.run(options)
+        directory = options[:directory]
+        database  = options[:trailing_args].first
+        
+        fm      = CouchRest::FileManager.new(database)
+        fm.loud = options[:loud]
+        puts "Pushing views from directory #{directory} to database #{fm.db}"
+        fm.push_views(directory)
+      end
+
+      def self.help
+        helpstring = <<-GEN
+
+        == Pushing views with Couchview ==
+
+        Usage: couchview push directory dbname
+
+        Couchview expects a specific filesystem layout for your CouchDB views (see
+        example below). It also supports advanced features like inlining of library
+        code (so you can keep DRY) as well as avoiding unnecessary document
+        modification.
+
+        Couchview also solves a problem with CouchDB's view API, which only provides
+        access to the final reduce side of any views which have both a map and a
+        reduce function defined. The intermediate map results are often useful for
+        development and production. CouchDB is smart enough to reuse map indexes for
+        functions duplicated across views within the same design document.
+
+        For views with a reduce function defined, Couchview creates both a reduce view
+        and a map-only view, so that you can browse and query the map side as well as
+        the reduction, with no performance penalty.
+
+        == Example ==
+
+        couchview push foo-project/bar-views baz-database
+
+        This will push the views defined in foo-project/bar-views into a database
+        called baz-database. Couchview expects the views to be defined in files with
+        names like:
+
+        foo-project/bar-views/my-design/viewname-map.js
+        foo-project/bar-views/my-design/viewname-reduce.js
+        foo-project/bar-views/my-design/noreduce-map.js
+
+        Pushed to => http://localhost:5984/baz-database/_design/my-design
+
+        And the design document:
+        {
+          "views" : {
+            "viewname-map" : {
+              "map" : "### contents of view-name-map.js ###"
+            },
+            "viewname-reduce" : {
+              "map" : "### contents of view-name-map.js ###",
+              "reduce" : "### contents of view-name-reduce.js ###"
+            },
+            "noreduce-map" : {
+              "map" : "### contents of noreduce-map.js ###"
+            }
+          }
+        }
+
+        Couchview will create a design document for each subdirectory of the views
+        directory specified on the command line.
+
+        == Library Inlining ==
+
+        Couchview can optionally inline library code into your views so you only have
+        to maintain it in one place. It looks for any files named lib.* in your
+        design-doc directory (for doc specific libs) and in the parent views directory
+        (for project global libs). These libraries are only inserted into views which
+        include the text
+
+        //include-lib
+
+        or
+
+        #include-lib
+
+        Couchview is a result of scratching my own itch. I'd be happy to make it more
+        general, so please contact me at jchris@grabb.it if you'd like to see anything
+        added or changed.
+
+        GEN
+        helpstring.gsub(/^        /, '')
+      end
+
+    end
+
+
+  end
+
+end

data/lib/couchrest.rb

@@ -8,4 +8,22 @@ require File.dirname(__FILE__) + '/pager'
 require File.dirname(__FILE__) + '/file_manager'
 require File.dirname(__FILE__) + '/streamer'
 
+# this has to come after the JSON gem
 
+# this date format sorts lexicographically
+# and is compatible with Javascript's new Date(time_string) constructor
+# note that sorting will break if you store times from multiple timezones
+# I like to add a ENV['TZ'] = 'UTC' to my apps
+class Time
+  def to_json(options = nil)
+    %("#{strftime("%Y/%m/%d %H:%M:%S %z")}")
+  end
+  # this works to decode the outputted time format
+  # from ActiveSupport
+  # def self.parse string, fallback=nil
+  #   d = DateTime.parse(string).new_offset
+  #   self.utc(d.year, d.month, d.day, d.hour, d.min, d.sec)
+  # rescue
+  #   fallback
+  # end
+end

data/lib/file_manager.rb

@@ -84,7 +84,7 @@ class CouchRest
 
         doc["_attachments"][path] = {
           "data" => content,
-          "content_type" => @content_types[path.split('.').last]
+          "content_type" => MIMES[path.split('.').last]
         }
       end
 
@@ -151,6 +151,40 @@ class CouchRest
       designs
     end
     
+    def pull_views(view_dir)
+      prefix = "_design"
+      ds = db.documents(:startkey => '#{prefix}/', :endkey => '#{prefix}/ZZZZZZZZZ')
+      ds['rows'].collect{|r|r['id']}.each do |id|
+        puts directory = id.split('/').last
+        FileUtils.mkdir_p(File.join(view_dir,directory))
+        views = db.get(id)['views']
+
+        vgroups = views.keys.group_by{|k|k.sub(/\-(map|reduce)$/,'')}
+        vgroups.each do|g,vs|
+          mapname = vs.find {|v|views[v]["map"]}
+          if mapname
+            # save map
+            mapfunc = views[mapname]["map"]
+            mapfile = File.join(view_dir, directory, "#{g}-map.js") # todo support non-js views
+            File.open(mapfile,'w') do |f|
+              f.write mapfunc
+            end
+          end
+
+          reducename = vs.find {|v|views[v]["reduce"]}
+          if reducename
+            # save reduce
+            reducefunc = views[reducename]["reduce"]
+            reducefile = File.join(view_dir, directory, "#{g}-reduce.js") # todo support non-js views
+            File.open(reducefile,'w') do |f|
+              f.write reducefunc
+            end
+          end
+        end
+      end  
+      
+    end
+    
     
     private
     
@@ -187,210 +221,3 @@ class CouchRest
     end
   end
 end
-
-__END__
-
-
-
-
-# parse the file structure to load the public files, controllers, and views into a hash with the right shape for coucdb
-couch = {}
-
-couch["public"] = Dir["#{File.expand_path(File.dirname("."))}/public/**/*.*"].collect do |f|
-  {f.split("public/").last => open(f).read}
-end
-
-couch["controllers"] = {}
-Dir["#{File.expand_path(File.dirname("."))}/app/controllers/**/*.*"].collect do |c|
-  path_parts = c.split("/")
-  
-  controller_name = path_parts[path_parts.length - 2]
-  action_name = path_parts[path_parts.length - 1].split(".").first
-
-  couch["controllers"][controller_name] ||= {"actions" => {}}
-  couch["controllers"][controller_name]["actions"][action_name] = open(c).read
-  
-end
-
-couch["designs"] = {}
-Dir["#{File.expand_path(File.dirname("."))}/app/views/**/*.*"].collect do |design_doc|
-  design_doc_parts = design_doc.split('/')
-  pre_normalized_view_name = design_doc_parts.last.split("-")
-  view_name = pre_normalized_view_name[0..pre_normalized_view_name.length-2].join("-")
-
-  folder = design_doc.split("app/views").last.split("/")[1]
-
-  couch["designs"][folder] ||= {}
-  couch["designs"][folder]["views"] ||= {}
-  couch["designs"][folder]["language"] ||= LANGS[design_doc_parts.last.split(".").last]
-  
-  if design_doc_parts.last =~ /-map/
-    couch["designs"][folder]["views"]["#{view_name}-map"] ||= {}
-
-    couch["designs"][folder]["views"]["#{view_name}-map"]["map"] = open(design_doc).read
-
-    couch["designs"][folder]["views"]["#{view_name}-reduce"] ||= {}
-    couch["designs"][folder]["views"]["#{view_name}-reduce"]["map"] = open(design_doc).read
-  end
-  
-  if design_doc_parts.last =~ /-reduce/
-    couch["designs"][folder]["views"]["#{view_name}-reduce"] ||= {}
-
-    couch["designs"][folder]["views"]["#{view_name}-reduce"]["reduce"] = open(design_doc).read
-  end
-end
-
-# cleanup empty maps and reduces
-couch["designs"].each do |name, props|
-  props["views"].delete("#{name}-reduce") unless props["views"]["#{name}-reduce"].keys.include?("reduce")
-end
-
-# parsing done, begin posting
-
-# connect to couchdb
-cr = CouchRest.new("http://localhost:5984")
-@db = cr.database(DBNAME)
-
-def create_or_update(id, fields)
-  existing = get(id)
-  
-  if existing
-    updated = fields.merge({"_id" => id, "_rev" => existing["_rev"]})
-  else
-    puts "saving #{id}"
-    save(fields.merge({"_id" => id}))
-  end
-  
-  if existing == updated
-    puts "no change to #{id}. skipping..."
-  else
-    puts "replacing #{id}"
-    save(updated)
-  end
-
-end
-
-def get(id)
-  doc = handle_errors do
-    @db.get(id)
-  end
-end
-
-def save(doc)
-  handle_errors do
-    @db.save(doc)
-  end
-end
-
-def handle_errors(&block)
-  begin
-    yield
-  rescue Exception => e
-    # puts e.message
-    nil
-  end
-end
-
-
-if todo.include? "views"
-  puts "posting views into CouchDB"
-  couch["designs"].each do |k,v|
-    create_or_update("_design/#{k}", v)
-  end
-  puts
-end
-
-if todo.include? "controllers"
-  puts "posting controllers into CouchDB"
-  couch["controllers"].each do |k,v|
-    create_or_update("controller/#{k}", v)
-  end
-  puts
-end
-
-
-if todo.include? "public"
-  puts "posting public docs into CouchDB"
-
-  if couch["public"].empty?
-    puts "no docs in public"; exit 
-  end
-  
-  @content_types = {
-    "html"       => "text/html",
-    "htm"        => "text/html",
-    "png"        => "image/png",
-    "css"        => "text/css",
-    "js"         => "test/javascript"
-  }
-  
-  def md5 string
-    Digest::MD5.hexdigest(string)
-  end
-    
-  @attachments = {}
-  @signatures = {}
-  couch["public"].each do |doc|
-    @signatures[doc.keys.first] = md5(doc.values.first)
-    
-    @attachments[doc.keys.first] = {
-      "data" => doc.values.first,
-      "content_type" => @content_types[doc.keys.first.split('.').last]
-    }
-  end
-  
-  doc = get("public")
-  
-  unless doc
-    puts "creating public"
-    @db.save({"_id" => "public", "_attachments" => @attachments, "signatures" => @signatures})
-    exit
-  end
-  
-  # remove deleted docs
-  to_be_removed = doc["signatures"].keys.select{|d| !couch["public"].collect{|p| p.keys.first}.include?(d) }
-  
-  to_be_removed.each do |p|
-    puts "deleting #{p}"
-    doc["signatures"].delete(p)
-    doc["_attachments"].delete(p)
-  end
-  
-  # update existing docs:
-  doc["signatures"].each do |path, sig|
-    if (@signatures[path] == sig)
-      puts "no change to #{path}. skipping..."
-    else
-      puts "replacing #{path}"
-      doc["signatures"][path] = md5(@attachments[path]["data"])
-      doc["_attachments"][path].delete("stub")
-      doc["_attachments"][path].delete("length")    
-      doc["_attachments"][path]["data"] = @attachments[path]["data"]
-      doc["_attachments"][path].merge!({"data" => @attachments[path]["data"]} )
-      
-    end
-  end
-  
-  # add in new files
-  new_files = couch["public"].select{|d| !doc["signatures"].keys.include?( d.keys.first) } 
-  
-  new_files.each do |f|
-    puts "creating #{f}"
-    path = f.keys.first
-    content = f.values.first
-    doc["signatures"][path] = md5(content)
-    
-    doc["_attachments"][path] = {
-      "data" => content,
-      "content_type" => @content_types[path.split('.').last]
-    }
-  end
-  
-  begin
-    @db.save(doc)
-  rescue Exception => e
-    puts e.message
-  end
-  
-  puts
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jchris-couchrest
 version: !ruby/object:Gem::Version 
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors: 
 - J. Chris Anderson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-03 00:00:00 -07:00
+date: 2008-09-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,9 @@ files:
 - lib/pager.rb
 - lib/file_manager.rb
 - lib/streamer.rb
+- lib/couch_rest/commands.rb
+- lib/couch_rest/commands/generate.rb
+- lib/couch_rest/commands/push.rb
 - Rakefile
 - README.markdown
 - bin/couchdir