soca 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/HISTORY

@@ -0,0 +1,3 @@
+== 0.1.0 [09-26-10]
+
+- Initial Release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Aaron Quint
+
+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.md

@@ -0,0 +1,89 @@
+# soca
+
+Sammy On Couch App or Sittin' On a Couch App
+
+## What?
+
+A *couchapp* is method of creating applications that live inside CouchDB's 
+design documents. This can be a simple as an index.html and as complicated
+as a full interactive JavaScript application. couchapp's inherently have a
+a bunch of really cool features - easy replication and synchronization,
+instant access to store and fetch data from CouchDB, and a full JS API. [Sammy.js](http://code.quirkey.com/sammy) is a perfect fit for couchapps providing a simple programmable controller layer on top of CouchDB's data.
+
+I highly recommend reading the section on couchapps in the [CouchDB Book](http://guide.couchdb.org/editions/1/en/standalone.html).
+
+*soca* is a simple command line tool written in ruby for building and pushing 
+couchapps. It is similar to and heavily inspired by the canonical couchapp
+python tool, [couchapp](http://github.com/couchapp/couchapp), with a number
+of key differences.
+
+* local directories do not have to map 1-1 to the design docs directory
+* lifecycle hooks for easily adding or modifying the design document with
+  ruby tools or plugins.
+* architected around using Sammy.js, instead of Evently, which is bundled
+  with the python tool.
+* super tiny and hackable, with the hope that people will contribute patches
+  and plugins.
+
+## Why?
+
+I'm not one to start a language war, I think python is great and the existing 
+couchapp tool works great for most situations. In fact I've built apps using
+it. I found myself working around the design documents structure, which makes 
+sense when in JSON, but much less sense when mapped to the filesystem. By making a simple tool, that takes a JSON map of directories and files and
+places them in their expected JSON slot, you make a new sort of couchapp.
+
+Unlike a traditional couchapp, a soca couchapp is actually one way - you're 
+source directory is actually 'compiled' into its final state. This allows you
+to do things you couldnt before, including bundling js files, using external
+tools like [compass](http://compassstyle.org), and just generally following
+your own preffered directory structure. This does mean that there is no `soca 
+clone` to get a couchapp out of CouchDB - though replicating works the same as 
+before (and is probably faster because you push only the docs you need or 
+use).
+
+The bottom line is I wanted to build couchapp's with a workflow and structure 
+I had already established - `soca` lets me do that.
+
+## How?
+
+`soca` is bundled as a ruby gem so installation is easy-peasy. On a system 
+with ruby and ruby gems (OS X for example):
+
+    gem install soca
+    
+This will give you the `soca` bin as long as gems are in your path.
+
+    soca
+    
+Will display all the command options.
+
+The typical workflow would be:
+
+    # Generate the app
+    soca generate myapp 
+    # cd into the app
+    cd myapp
+    # edit your .couchapprc with the db url
+    # Do your work, editing app.js, etc
+    # push the app to couchdb
+    soca push
+    # open the app in a browser
+    soca open
+
+Once you get it set up, you can also use 
+
+    soca autopush
+    
+Which will watch the directory and push your changes automagically.
+
+## TODO
+
+* Better Docs
+* More plugins
+* More generate options (compass scaffold, etc)
+* More example apps
+
+## Copyright/License
+
+Copyright (c) 2010 Aaron Quint under the MIT License. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'lib/soca'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "soca"
+    gem.version = Soca::VERSION
+    gem.summary = %Q{Sammy on CouchApp}
+    gem.description = %Q{soca is a different way of writing apps for CouchDB. The structure is up to you.}
+    gem.email = "aaron@quirkey.com"
+    gem.homepage = "http://github.com/quirkey/soca"
+    gem.authors = ["Aaron Quint"]
+    gem.add_dependency 'json', '~>1.4.6'
+    gem.add_dependency 'typhoeus', '~>0.1.31'
+    gem.add_dependency 'jim', '~>0.2.3'
+    gem.add_dependency 'compass', '~>0.10.5'
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/bin/soca

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'soca'
+
+Soca::CLI.start

data/lib/soca.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'typhoeus'
+require 'base64'
+require 'mime/types'
+require 'logger'
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__))))
+
+module Soca
+  VERSION = '0.1.0'
+
+  class << self
+    attr_accessor :debug
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.logger
+    @logger ||= LOGGER if defined?(LOGGER)
+    if !@logger
+      @logger           = Logger.new(STDOUT)
+      @logger.level     = Logger::ERROR
+      @logger.formatter = Proc.new {|s, t, n, msg| "#{msg}\n"}
+      @logger
+    end
+    @logger
+  end
+end
+
+require 'soca/pusher'
+require 'soca/cli'
+require 'soca/plugin'

data/lib/soca/cli.rb

@@ -0,0 +1,189 @@
+require 'thor'
+require 'thor/actions'
+
+module Soca
+  class CLI < ::Thor
+    include Thor::Actions
+
+    attr_accessor :appdir,
+                  :config_file,
+                  :debug
+
+    class_option "appdir",
+          :type => :string,
+          :banner => "set the application directory to work with. assumes the current directory"
+
+    class_option "config",
+        :aliases => '-c',
+        :type => :string,
+        :banner => "use a specific soca config.js"
+
+    class_option "debug",
+        :type => :boolean,
+        :default => false,
+        :aliases => '-d',
+        :banner => "set log level to debug"
+
+    class_option "version",
+        :type => :boolean,
+        :aliases => '-v',
+        :banner => "print version and exit"
+
+    default_task :help
+
+    def initialize(*)
+      super
+      if options[:version]
+        say "soca #{Soca::VERSION}", :red
+        exit
+      end
+      self.appdir      = options[:appdir] || File.expand_path(Dir.pwd)
+      self.config_file = options[:config]
+      self.debug       = options[:debug]
+      if debug
+        Soca.debug = true
+        logger.level = Logger::DEBUG
+      end
+      self.source_paths << File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+    end
+
+    method_option "appname",
+          :type => :string,
+          :banner => "set the name of the application for templating. defaults to the basename of the appdir"
+
+    desc 'init [APPDIR]', 'turns any directory into a soca app, generating a config.js'
+    def init(to = nil)
+      self.appdir = to if to
+      self.destination_root = appdir
+      @dir_mappings = {}
+      Dir[appdir + '*'].each do |filename|
+        basename = File.basename(filename)
+        @dir_mappings[basename] = "_attachments/#{basename}"
+      end
+      template('config.js.erb', 'config.js')
+      template('couchapprc.erb', '.couchapprc')
+    end
+
+    method_option "appname",
+          :type => :string,
+          :banner => "set the name of the application for templating. defaults to the basename of the appdir"
+
+    desc 'generate [APPDIR]', 'generates the basic soca app structure'
+    def generate(to = nil)
+      self.appdir = to if to
+      self.destination_root = appdir
+
+      directory('hooks')
+      directory('js')
+      directory('css')
+      directory('db')
+      template('Jimfile')
+      template('index.html.erb', 'index.html')
+      @dir_mappings = {
+        "config.js"  => "",
+        "index.html" => "_attachments/index.html",
+        "css"        => "_attachments/css",
+        "images"     => "_attachments/images",
+        "sass"       => false,
+        "js"         => "_attachments/js",
+        "templates"  => "_attachments/templates",
+        "db"         => "",
+        "Jimfile"    => false,
+        "hooks"      => false
+      }
+      template('config.js.erb', 'config.js')
+      template('couchapprc.erb', '.couchapprc')
+    end
+
+    desc 'url [ENV]', 'outputs the app url for the ENV'
+    def url(env = 'default')
+      say pusher(env).app_url
+    end
+
+    desc 'open [ENV]', 'attempts to open the url for the current app in a browser'
+    def open(env = 'default')
+      `open #{pusher(env).app_url}`
+    end
+
+    desc 'push [ENV]', 'builds and pushes the current app to couchdb'
+    def push(env = 'default')
+      pusher(env).push!
+    end
+
+    desc 'build [ENV]', 'builds the app as a ruby hash and outputs it to stdout'
+    def build(env = 'default')
+      require 'pp'
+      pp pusher(env).build
+    end
+
+    desc 'compact [ENV]', 'runs a DB compact against the couchdb for ENV'
+    def compact(env = 'default')
+      pusher(env).compact!
+    end
+
+    desc 'json [ENV]', 'builds and then outputs the design doc JSON for the app'
+    def json(env = 'default')
+      say pusher(env).json
+    end
+
+    method_option '--compact', :type => :numeric, :default => 5,
+      :banner => 'run a compact operation every [n] pushes (default 5)'
+    desc 'autopush [ENV]', 'watches the current directory for changes, building and pushing to couchdb'
+    def autopush(env = 'default')
+      push = pusher(env)
+      files = {}
+      compact = options[:compact]
+      times = 0
+      loop do
+        changed = false
+        Dir.glob(push.app_dir + '**/**') do |file|
+          ctime = File.ctime(file).to_i
+          if ctime != files[file]
+            files[file] = ctime
+            changed = true
+            break
+          end
+        end
+
+        if changed
+          say "Running push at #{Time.now}", :yellow
+          begin
+            push.push!
+          rescue => e
+            say "Error running push #{e}", :red
+          end
+
+          Dir.glob(push.app_dir + '**/**') do |file|
+            ctime = File.ctime(file).to_i
+            if ctime != files[file]
+              files[file] = ctime
+            end
+          end
+          times += 1
+          if compact && times % compact == 0
+            say "pushed #{times} times, running a compact", :yellow
+            push.compact!
+          end
+          say "Waiting for a file change", :green
+          say "-------------------------"
+        end
+
+        sleep 1
+      end
+    end
+
+    private
+    def appname
+      @appname = options[:name] || File.basename(appdir)
+    end
+
+    def logger
+      Soca.logger
+    end
+
+    def pusher(env)
+      Soca::Pusher.new(appdir, env, config_file)
+    end
+
+  end
+end

data/lib/soca/plugin.rb

@@ -0,0 +1,31 @@
+module Soca
+  class Plugin
+    attr_reader :pusher
+
+    def self.name(plugin_name)
+      @@plugins ||= {}
+      @@plugins[plugin_name] = self
+    end
+
+    def self.plugins
+      @@plugins ||= {}
+    end
+
+    def initialize(pusher)
+      @pusher = pusher
+    end
+
+    def run
+      raise "you need to subclass plugin and provide your own logic, please"
+    end
+
+    def logger
+      Soca.logger
+    end
+
+    def app_dir
+      pusher.app_dir
+    end
+
+  end
+end