proscribe 0.0.1

data/lib/proscribe/project.rb

@@ -0,0 +1,92 @@
+# Class: Project (ProScribe)
+# A project.
+#
+# ## Internal usage
+#
+#     p = Project.new(config_file)
+#
+module ProScribe
+  class Project
+    # Attribute: config (ProScribe::Project)
+    # Returns a hash of the project's configuration, pulled from Scribefile.
+    #
+    attr_reader :config
+
+    def initialize(config_file)
+      @root   = File.dirname(config_file)
+      @config = Hashie::Mash.new(YAML::load_file(config_file))
+
+      # Defaults
+      @config.manual  ||= '.'
+      @config.output  ||= 'doc'
+      @config.files   ||= Array.new
+    end
+
+    # Attribute: root (ProScribe::Project)
+    # Returns the root path.
+    #
+    # ##  Usage
+    #     project.root
+    #     project.root(*args)
+    #
+    def root(*a)
+      File.join(@root, *a)
+    end
+
+    # Attribute: manual_path (ProScribe::Project)
+    # Returns the absolute path to the projects's manual.
+    #
+    def manual_path
+      root(@config.manual)
+    end
+
+    # Method: make (ProScribe::Project)
+    # Creates the temp dir from the project's manual and inline comments.
+    #
+    def make
+      dir
+
+      # Copy the files over
+      copy_files ProScribe.root('data/default/'), dir
+
+      # Copy manual files over
+      copy_files manual_path, dir, :except => ['Gemfile', 'Gemfile.lock', 'config.ru']
+
+      # Extract block comments
+      config.files.each do |group|
+        ex = ProScribe::Extractor.new Dir[root(group.source)]
+        ex.write! File.join(dir, group.target)
+      end
+    end
+
+    # Attribute: dir (ProScribe::Project)
+    # Returns the path to the temporary Proton project.
+    #
+    def dir(*a)
+      @dir ||= begin
+        dir = File.join(Dir.tmpdir, File.basename(root))
+        FileUtils.rm_rf dir
+        FileUtils.mkdir_p dir
+        dir
+      end
+
+      File.join(@dir, *a)
+    end
+
+  private
+
+    def copy_files(from, to, options={})
+      exceptions = options[:except] || []
+
+      Dir["#{from}/**/*"].each do |f|
+        next  unless File.file?(f)
+        next  if exceptions.include?(File.basename(f))
+
+        target = File.join(to, f.gsub(from, ''))
+
+        FileUtils.mkdir_p File.dirname(target)
+        FileUtils.cp f, target
+      end
+    end
+  end
+end

data/lib/proscribe/rack_app.rb

@@ -0,0 +1,26 @@
+require 'proton'
+require 'proton/server'
+require 'shake'
+
+# Module: RackApp
+# Provides a Rack app.
+#
+# ## Usage
+#
+# Use {ProScribe.rack_app}.
+#
+module ProScribe
+  module RackApp
+    def self.run!
+      config  = Shake.find_in_project("Scribefile") or return
+      project = ProScribe::Project.new(config)
+      project.make
+
+      watcher = ProScribe::Watcher.new(project) { |_, file| puts "Updated #{file}" }
+
+      proton = Proton::Project.new(project.dir)
+
+      Proton::Server
+    end
+  end
+end

data/lib/proscribe/version.rb

@@ -0,0 +1,11 @@
+module ProScribe
+  # Class method: version (ProScribe)
+  # Returns the version of the ProScribe gem.
+  #
+  # ##  Example
+  #     ProScribe.version     #=> "0.0.1"
+  #
+  def self.version
+    "0.0.1"
+  end
+end

data/lib/proscribe/watcher.rb

@@ -0,0 +1,63 @@
+# Class: Watcher (ProScribe)
+# Monitors files for changes.
+#
+# ## Common usage
+#
+#     w = Watcher.new(project) { puts 'update' }
+#     w.join
+#
+module ProScribe
+  class Watcher
+    def initialize(project, &blk)
+      require 'fssm'
+
+      @threads = Array.new
+
+      # Monitor the project's manual
+      @threads << Thread.new {
+        monitor(project.config.manual) { |*a| project.make; yield *a }
+      }
+
+      # Monitor ProScribe's default theme
+      @threads << Thread.new {
+        monitor(ProScribe.root('data')) { |*a| project.make; yield *a }
+      }
+
+      # Monitor the project's files
+      project.config.files.each do |group|
+        threads << Thread.new {
+          path = project.root(group.source)
+          path = path.gsub(/\*.*$/, '')
+          path = File.realpath(path)
+
+          monitor(path) { |*a| project.make; yield *a }
+        }
+      end
+    end
+
+    # Attribute: threads (ProScribe::Watcher)
+    # The threads.
+    # 
+    attr_reader :threads
+
+    # Method: join (ProScribe::Watcher)
+    # Asks all threads to join.
+    #
+    def join
+      threads.each { |t| t.join }
+    end
+
+  private
+    def monitor(path, &blk)
+      updated = lambda { |path, file|
+        yield path, file
+      }
+
+      FSSM.monitor(path) do
+        update(&updated)
+        create(&updated)
+        delete(&updated)
+      end
+    end
+  end
+end

data/lib/proscribe.rb

@@ -0,0 +1,40 @@
+require 'yaml'
+require 'fileutils'
+require 'tmpdir'
+require 'shake'
+require 'hashie'
+require 'tilt'
+
+# Module: ProScribe
+# The main module.
+#
+module ProScribe
+  def self.root(*a)
+    File.join(File.expand_path('../../', __FILE__), *a)
+  end
+
+  PREFIX = File.expand_path('../', __FILE__)
+
+  autoload :Project,    "#{PREFIX}/proscribe/project"
+  autoload :Helpers,    "#{PREFIX}/proscribe/helpers"
+  autoload :CLI,        "#{PREFIX}/proscribe/cli"
+  autoload :Extractor,  "#{PREFIX}/proscribe/extractor"
+  autoload :Watcher,    "#{PREFIX}/proscribe/watcher"
+  autoload :RackApp,    "#{PREFIX}/proscribe/rack_app"
+
+  require "#{PREFIX}/proscribe/version"
+
+  # Class method: rack_app (ProScribe)
+  # Returns a Rack app for the current dir's ProScribe project.
+  #
+  # ## Usage
+  #
+  #     [config.ru (ruby)]
+  #     require 'proscribe'
+  #     run ProScribe.rack_app
+  #
+  def self.rack_app
+    RackApp.run! && Proton::Server
+  end
+end
+

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: proscribe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rico Sta. Cruz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-24 00:00:00.000000000 +08:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &2153048280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153048280
+- !ruby/object:Gem::Dependency
+  name: shake
+  requirement: &2153047780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153047780
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: &2153047320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153047320
+- !ruby/object:Gem::Dependency
+  name: proton
+  requirement: &2153046860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153046860
+- !ruby/object:Gem::Dependency
+  name: fssm
+  requirement: &2153046400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153046400
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &2153045940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153045940
+description: Build some documentation for your projects of any language.
+email:
+- rico@sinefunc.com
+executables:
+- proscribe
+extensions: []
+extra_rdoc_files: []
+files:
+- data/default/_extensions/manual/lib/cli.rb
+- data/default/_extensions/manual/lib/extractor.rb
+- data/default/_extensions/manual/lib/helpers.rb
+- data/default/_extensions/manual/manual.rb
+- data/default/_layouts/_nav.haml
+- data/default/_layouts/default.haml
+- data/default/Gemfile
+- data/default/Gemfile.lock
+- data/default/Protonfile
+- data/default/style.scss
+- data/rack/config.ru
+- data/rack/Gemfile
+- bin/proscribe
+- lib/proscribe/cli.rb
+- lib/proscribe/extractor.rb
+- lib/proscribe/helpers.rb
+- lib/proscribe/project.rb
+- lib/proscribe/rack_app.rb
+- lib/proscribe/version.rb
+- lib/proscribe/watcher.rb
+- lib/proscribe.rb
+- HISTORY.md
+- README.md
+has_rdoc: true
+homepage: http://github.com/rstacruz/proscribe
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Documentation generator.
+test_files: []