adocsite 1.0.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+deploy
+work
+.project
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in adocsite.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+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,82 @@
+# ADocSite in a few words
+
+The idea behind this gem is this:
+
+* You have a bunch of text files where you keep your howto's, todo's, brilliant ideas, code snippets, etc. etc.
+* There's just so many of them already, and you are loosing track of what is where
+* You wish you can have a sort of index of them all where you can easily find them and navigate between them.
+
+ADocSite takes:
+
+* All those text files which are kept somewhere around in bunch of folders with funny names.
+* All the images and other files that you keep with those text documents.
+
+and generates one simple static web site out of it.
+
+Now you can go, open index.html and browse through all those documents of yours and view them as web pages.
+
+# Some more details 
+
+ADocSite is implemented in [Ruby](https://www.ruby-lang.org/en/). It expects that all files with content are 
+written as [asciidoc](http://www.methods.co.nz/asciidoc/) text files. These files are converted into HTML using [asciidoctor](http://asciidoctor.org/).
+
+All documents are considered to be **articles** unless they are explicitly marked to be **pages**.
+Articles can be grouped into **categories**, pages are entities for them selves. That's the only difference
+between the two.
+
+Usually, asciidoctor generates one complete HTML page from one text file, head, body and all. ADocSite uses
+asciidoctor to render text file content as a HTML section, without html, head and body tags. This _partial_ HTML
+text is then inserted into final HTML page at it's predeterminad place.
+
+You can already tell: how final HTML pages look is determined by **templates**. ADocSite uses [HAML](http://haml.info/)
+templates so its final output can take any shape and form you wish it to take.
+
+So, there you have it:
+
+ADocSite generates static web site.
+
+All content consists of **asciidoc formatted text files**.
+
+There are **articles**, organized into **categories**, and **pages**.
+
+Final shape of everything is controlled by haml **templates**.
+
+ADocSite **is** very simple to use and to play with. Don't let the _"asciidoc formatted text file"_ thing
+scare you. You only need to know three things as a necessarry minimum to write asciidoc files:
+
+* how to write a document title
+* how to write a list of categories that the article belongs to
+* how to type on a keyboard
+
+That's it.
+
+Really.
+
+[Here, let me show you...](http://myblueraven.com/adocsite).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'adocsite'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adocsite
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/adocsite/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO.md

@@ -0,0 +1,12 @@
+# Adocsite
+
+Bugz
+
+* [ ] when posting article, if code crashes after initial post, article draft is left at the Wordpress server.
+* [ ] different posts that link to same image create multiple media library entries for that same image.
+
+
+Just a list of things worth looking into.
+
+* [ ] should engine be reusable or should it be created new for each theme/layout combination?
+

data/adocsite.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adocsite/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "adocsite"
+  spec.version       = Adocsite::VERSION
+  spec.authors       = ["Bruce Brennan"]
+  spec.email         = ["bb@myblueraven.com"]
+  spec.summary       = %q{Static site generator.}
+  spec.description   = %q{Very simple static site generator for asciidoc documents.}
+  spec.homepage      = "http://myblueraven.com/adocsite"
+  spec.license       = "GPL v3"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'haml'
+  spec.add_dependency 'asciidoctor'
+  spec.add_dependency 'tilt'
+  spec.add_dependency 'commander'
+  spec.add_dependency 'rubypress'
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'terminal-table'
+  spec.add_dependency 'mime-types'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/bin/adocsite

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+
+require 'bundler/setup'
+require 'adocsite'
+
+
+program :version, '1.0.0'
+program :description, 'Very simple static site generator for asciidoc documents'
+
+default_command :build
+
+command :build do |c|
+  c.syntax = 'adocsite build [options]'
+  c.summary = ''
+  c.description = 'Creates static web site from your asciidoc documents'
+  c.example 'Build using default layout', 'adocsite build'
+  c.example 'Build using some other layout', 'adocsite build --layout compact'
+  c.option '--layout STRING', String, 'Specify layout to use for the theme'
+  c.option '--config STRING', String, 'Specify configuration file to use for build'
+  c.action do |args, options|
+  	options.default :layout => 'default'
+
+    Adocsite::Commands::build args, options
+  end
+end
+
+command :dump do |c|
+  c.syntax = 'adocsite dump'
+  c.summary = ''
+  c.description = 'Dumps default configuration, example custom config file and folder with default templates'
+  c.example 'Dump templates and configuration', 'adocsite dump'
+  c.action do |args, options|
+    Adocsite::Commands::dump args, options
+  end
+end
+
+command :post do |c|
+  c.syntax = 'adocsite post  [--config config_file] article_name | --title "article title"'
+  c.summary = ''
+  c.description = 'Post article to a Wordpress blog'
+  c.example 'Post an article by it\'s key name', 'adocsite post my_article_for_blog'
+  c.example 'Post an article by it\'s title', 'adocsite post --title "My article for blog"'
+  c.option '--title STRING', String, 'Specify article to post by it\'s title'
+  c.option '--config STRING', String, 'Specify configuration file to use for posting article'
+  c.action do |args, options|
+    Adocsite::Commands::post args, options
+  end
+end
+
+command :list do |c|
+  c.syntax = 'adocsite list  [--config config_file]'
+  c.summary = ''
+  c.description = 'List all available articles'
+  c.example 'List all available articles', 'adocsite post --list'
+  c.option '--config STRING', String, 'Specify configuration file to use for posting article'
+  c.action do |args, options|
+    Adocsite::Commands::list args, options
+  end
+end
+

data/examples/myconfig.rb

@@ -0,0 +1,7 @@
+# Example custom configuration for Adocsite
+
+Adocsite::config = {
+    :SITE_TITLE => "Title of My Site",
+    :SITE_URL => "http://www.example.com/",
+    :INPUT_FOLDERS => ["mysite", "docs"],
+  }

data/examples/mywpconfig.rb

@@ -0,0 +1,9 @@
+# Example custom configuration for Adocsite Wordpress posting
+
+Adocsite::wpconfig = {
+      :host => 'http://www.example.com',
+      :path => "/xmlrpc.php",
+      :port => 80,
+      :username => "editor",
+      :password => "editor"
+  }

data/lib/adocsite.rb

@@ -0,0 +1,35 @@
+require "adocsite/version"
+
+module Adocsite
+  #
+end
+
+# built-in
+require 'csv'
+require 'fileutils'
+require 'uri'
+
+# required for gems
+require 'rubygems'
+require 'bundler/setup'
+
+# gems
+require 'haml'
+require 'asciidoctor'
+require 'tilt'
+require 'nokogiri'
+require 'terminal-table'
+require 'rubypress'
+require 'mime/types'
+
+# adocsite
+require 'adocsite/content_loader'
+require 'adocsite/content_types'
+require 'adocsite/context'
+require 'adocsite/engine'
+require 'adocsite/site'
+require 'adocsite/templates'
+require 'adocsite/commands'
+require 'adocsite/config'
+
+require 'adocsite/wp/post'

data/lib/adocsite/commands.rb

@@ -0,0 +1,83 @@
+module Adocsite
+  class Commands
+    def Commands.build(args, options)
+      user_config_file_name = options.config || "adocsite_config.rb"
+      user_config_file = File.join(Dir.pwd, user_config_file_name)
+      if File.exists?(user_config_file)
+        require user_config_file
+      end
+
+      engine = Adocsite::Engine.new
+      engine.build(options.layout)
+    end
+
+    def Commands.dump(args, options)
+      # default template
+      FileUtils.cp_r(Adocsite.config[:TEMPLATES_FOLDER], "adocsite_default_template")
+
+      # default configuration
+      conf = <<-EOS
+# Default configuration for Adocsite
+
+Adocsite::config = #{Adocsite.config.pretty_inspect}
+
+EOS
+      File.open("adocsite_default_config.rb", 'w') {|f| f.write(conf) }
+      
+      # example of custom configuration file
+      sample_custom_config = File.join(File.dirname(__FILE__), "..", "..", "examples", "myconfig.rb")
+      FileUtils.cp(sample_custom_config, "adocsite_custom_config_sample.rb")
+      
+      # example of custom wp configuration file
+      sample_custom_config = File.join(File.dirname(__FILE__), "..", "..", "examples", "mywpconfig.rb")
+      FileUtils.cp(sample_custom_config, "adocsite_wp_config_sample.rb")
+    end
+
+    def Commands.post(args, options)
+      user_config_file_name = options.config || "adocsite_wp_config.rb"
+      user_config_file = File.join(Dir.pwd, user_config_file_name)
+      if File.exists?(user_config_file)
+        require user_config_file
+      end
+
+      wp = Adocsite::WpPost.new
+      
+      if options.list
+        alist = wp.list_articles
+        atable = []
+        alist.each_pair {|key, value|
+          atable << [key.to_str, value]
+          }
+        puts Terminal::Table.new :headings => ['name', 'title'], :rows => atable
+      elsif options.title
+        wp.process_by_title(options.title)
+      else
+        article_name = args.shift || abort('Article title is required.')
+        wp.process(article_name)
+      end
+
+      puts 'Done.'
+    end
+
+    def Commands.list(args, options)
+      user_config_file_name = options.config || "adocsite_config.rb"
+      user_config_file = File.join(Dir.pwd, user_config_file_name)
+      if File.exists?(user_config_file)
+        require user_config_file
+      end
+
+      alist = Hash.new
+      engine = Adocsite::Engine.new
+      engine.content_loader.articles.collect{|key, article| alist[key] = article.title}
+
+      atable = []
+      alist.each_pair {|key, value|
+        atable << [key.to_str, value]
+        }
+      puts Terminal::Table.new :headings => ['name', 'title'], :rows => atable
+
+      puts 'Done.'
+    end
+
+  end
+end

data/lib/adocsite/config.rb

@@ -0,0 +1,66 @@
+module Adocsite
+  ##################################
+  # AdocSite configuration
+  #
+
+  def config
+    @settings || Adocsite::DefaultSettings
+  end
+
+  def config= value
+    @settings = self.config.merge(value)
+  end
+
+  DefaultSettings = {
+    # general stuff
+    :SITE_TITLE => "Site Title",
+    # if you really want you can put site url here
+    # but then you will not be able to browse site by
+    # opening index.html file from file explorer
+    :SITE_URL => "",
+
+    # input locations
+    :INPUT_FOLDERS => ["work", "docs"],
+    :TEMPLATES_FOLDER => File.join(File.dirname(__FILE__), "..", "..", "tpl"),
+
+    # output locations
+    :OUTPUT_FOLDER => "deploy",
+    :STYLES_FOLDER => "css",
+    :SCRIPTS_FOLDER => "js",
+    :IMAGES_FOLDER => "img",
+
+    # templates
+    :THEME => "default",
+
+    # file filters
+    :STYLES => ".css",
+    :SCRIPTS => ".js",
+    # constant (or variable) defined like this can be passed to method that accepts multiple arguments using *
+    # i.e. String.ends_with?(*IMAGES)
+    :IMAGES => [".jpg", ".jpeg", ".gif", ".png", ".tif", ".bmp", ".svg"],
+    :DOCUMENTS => ".adoc",
+    :TEMPLATES => ".haml",
+  }
+  
+  ##################################
+  # Posting articles to Wordpress
+  #
+
+  def wpconfig
+    @wpsettings || Adocsite::DefaultWpSettings
+  end
+
+  def wpconfig= value
+    @wpsettings = self.wpconfig.merge(value)
+  end
+
+  DefaultWpSettings = {
+      :host => "localhost",
+      :path => "/xmlrpc.php",
+      :port => 80,
+      :username => "editor",
+      :password => "editor"
+  }
+
+  module_function :config, :config=, :wpconfig, :wpconfig=
+end