alf-doc 0.15.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 0.15.0 / FIX ME
+
+* Enhancements
+
+  * Birthday!

data/Gemfile

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+group :runtime do
+  gem "alf-core", path: "../alf-core"
+end
+
+group :development do
+  gem "wlang", "~> 2.1"
+  gem "redcarpet", "~> 3.0"
+  gem "albino", "~> 1.3"
+  gem "md2man", "~> 2.0"
+  gem "rake", "~> 10.0"
+  gem "rspec", "~> 2.12"
+end

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: ../alf-core
+  specs:
+    alf-core (0.15.0)
+      domain (~> 1.0)
+      myrrha (~> 3.0)
+      path (~> 1.3)
+      sexpr (~> 0.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    albino (1.3.3)
+      posix-spawn (>= 0.3.6)
+    backports (2.8.2)
+    binman (3.3.2)
+      opener (>= 0.1.0, < 1)
+    citrus (2.4.1)
+    diff-lcs (1.2.4)
+    domain (1.0.0)
+    md2man (2.0.2)
+      binman (~> 3.0)
+      redcarpet (~> 3.0)
+    myrrha (3.0.0)
+      domain (~> 1.0)
+    opener (0.1.0)
+    path (1.3.3)
+    posix-spawn (0.3.6)
+    quickl (0.4.3)
+    rake (10.1.0)
+    redcarpet (3.0.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    sexpr (0.6.0)
+    temple (0.6.7)
+    wlang (2.2.3)
+      backports (~> 2.6)
+      citrus (~> 2.4.1)
+      path (~> 1.3)
+      quickl (~> 0.4.3)
+      temple (~> 0.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  albino (~> 1.3)
+  alf-core!
+  md2man (~> 2.0)
+  rake (~> 10.0)
+  redcarpet (~> 3.0)
+  rspec (~> 2.12)
+  wlang (~> 2.1)

data/LICENCE.md

@@ -0,0 +1,22 @@
+# The MIT Licence
+
+    Copyright (c) 2013 - Bernard Lambeau
+
+    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/Manifest.txt

@@ -0,0 +1,12 @@
+doc.gemspec
+doc.noespec
+CHANGELOG.md
+Gemfile
+Gemfile.lock
+lib/**/*
+LICENCE.md
+Manifest.txt
+Rakefile
+README.md
+spec/**/*
+tasks/**/*

data/README.md

@@ -0,0 +1,10 @@
+# Alf::Doc
+
+[![Build Status](https://secure.travis-ci.org/alf-tool/alf-doc.png)](http://travis-ci.org/blambeau/alf-doc)
+[![Dependency Status](https://gemnasium.com/alf-tool/alf-doc.png)](https://gemnasium.com/blambeau/alf-doc)
+
+Documentation of Alf relational algebra
+
+## Links
+
+http://github.com/blambeau/alf

data/Rakefile

@@ -0,0 +1,14 @@
+$:.unshift(File.expand_path('../lib', __FILE__))
+require 'alf-doc'
+
+#
+# Install all tasks found in tasks folder
+#
+# See .rake files there for complete documentation.
+#
+Dir["tasks/*.rake"].each do |taskfile|
+  load taskfile
+end
+
+# We run tests by default
+task :default => :test

data/lib/alf/doc/loader.rb

@@ -0,0 +1 @@
+require "alf-core"

data/lib/alf/doc/to_html.rb

@@ -0,0 +1,47 @@
+require 'wlang'
+require 'albino'
+require 'redcarpet'
+require 'base64'
+require_relative 'to_markdown'
+module Alf
+  module Doc
+    class ToHtml
+
+      class HTMLwithAlbino < Redcarpet::Render::HTML
+        def block_code(code, language)
+          Albino.colorize(code, language || :ruby)
+        end
+      end
+
+      def operator(op)
+        to_html(ToMarkdown.new.operator(op))
+      end
+
+      def aggregator(op)
+        to_html(ToMarkdown.new.aggregator(op))
+      end
+
+      def predicate(op)
+        to_html(ToMarkdown.new.predicate(op))
+      end
+
+      def page(md)
+        to_html(md)
+      end
+
+      def to_html(src)
+        src = src.gsub(/([ ]*)```try\n(.*?)\n([ ]*)```/m){|m|
+          spacing = $1 || ""
+          source  = $2.strip.gsub(/^#{spacing}/, "")
+          quoted  = Base64.encode64(source)
+          source  = "```\n#{source}\n```"
+          source  = source.gsub(/^/, spacing)
+          %Q{#{source}\n<div class="try-this"><a href="/?src=#{quoted}" target="_blank">Try it!</a></div>}
+        }
+        options = {:fenced_code_blocks => true}
+        Redcarpet::Markdown.new(HTMLwithAlbino, options).render(src)
+      end
+
+    end # class ToHtml
+  end # module Doc
+end # module Alf

data/lib/alf/doc/to_markdown.rb

@@ -0,0 +1,28 @@
+require 'wlang'
+module Alf
+  module Doc
+    class ToMarkdown
+
+      TEMPLATES = Path.backfind('doc/templates')
+
+      def operator(op)
+        to_markdown(TEMPLATES/"operator.wlang", op)
+      end
+
+      def aggregator(op)
+        to_markdown(TEMPLATES/"aggregator.wlang", op)
+      end
+
+      def predicate(op)
+        to_markdown(TEMPLATES/"predicate.wlang", op)
+      end
+
+    private
+
+      def to_markdown(tpl, context)
+        WLang::Html.render(tpl, context)
+      end
+
+    end # class ToMarkdown
+  end # module Doc
+end # module Alf

data/lib/alf/doc/version.rb

@@ -0,0 +1,16 @@
+module Alf
+  module Doc
+    module Version
+
+      MAJOR = 0
+      MINOR = 15
+      TINY  = 0
+
+      def self.to_s
+        [ MAJOR, MINOR, TINY ].join('.')
+      end
+
+    end
+    VERSION = Version.to_s
+  end
+end

data/lib/alf/doc/viewpoint.rb

@@ -0,0 +1,37 @@
+module Alf
+  module Doc
+    module Viewpoint
+      include Alf::Viewpoint
+
+      def aggregators
+        @aggregators ||= load_file("aggregators")
+      end
+
+      def operators
+        @operators ||= load_file("operators")
+      end
+
+      def predicates
+        @predicates ||= load_file("predicates")
+      end
+
+      def examples
+        @examples ||= begin
+          ex = (Doc::ROOT/'examples').glob("*.alf").map do |file|
+            { source: file.read }
+          end
+          Relation(ex)
+        end
+      end
+
+    private
+
+      def load_file(who)
+        folder = Doc::DOC_ROOT/who
+        tuples = folder.glob('*.yml').map(&:load)
+        Relation(tuples)
+      end
+
+    end # class Viewpoint
+  end # module Doc
+end # module Alf

data/lib/alf/doc.rb

@@ -0,0 +1,52 @@
+require_relative 'doc/version'
+require_relative 'doc/loader'
+require_relative 'doc/viewpoint'
+module Alf
+  module Doc
+
+    ROOT = Path.dir.parent.parent
+
+    DOC_ROOT = ROOT/"doc"
+
+    DB = Alf.connect(Path.dir, viewpoint: Viewpoint[])
+
+    def self.query(*args, &bl)
+      DB.query(*args, &bl)
+    end
+
+    def self.all
+      query{
+        extend(Relation::DEE,
+          predicates: predicates,
+          operators: operators,
+          aggregators: aggregators,
+          examples: examples)
+      }
+    end
+
+    def self.examples
+      query{ examples }
+    end
+
+    def self.pages
+      (DOC_ROOT/'pages').glob("*.md")
+    end
+
+    def self.commands
+      (DOC_ROOT/'commands').glob("*.md")
+    end
+
+    def self.blog
+      (DOC_ROOT/'blog').glob("*.md")
+    end
+
+    def self.each_api
+      [:operators, :predicates, :aggregators].each do |kind|
+        Alf::Doc.query(kind).each do |obj|
+          yield(kind.to_s[0...-1].to_sym, obj.name, obj)
+        end
+      end
+    end
+
+  end # module Doc
+end # module Alf

data/lib/alf-doc.rb

@@ -0,0 +1 @@
+require_relative "alf/doc"

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'alf-doc'
+require "rspec"
+
+module Helpers
+
+end
+
+RSpec.configure do |c|
+  c.include Helpers
+  c.extend  Helpers
+  c.filter_run_excluding :ruby19 => (RUBY_VERSION < "1.9")
+end

data/spec/test_doc.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+module Alf
+  describe Doc do
+
+    it "should have a version number" do
+      Doc.const_defined?(:VERSION).should be_true
+    end
+
+    it 'has valid .yml files' do
+      Doc.all.should be_a(Relation)
+    end
+
+    it 'has valid predicates' do
+      predicates = Doc.query(:predicates)
+      predicates.should be_a(Relation)
+      predicates.should_not be_empty
+    end
+
+    it 'has valid operators' do
+      operators = Doc.query(:operators)
+      operators.should be_a(Relation)
+      operators.should_not be_empty
+    end
+
+    it 'has valid aggregators' do
+      aggregators = Doc.query(:aggregators)
+      aggregators.should be_a(Relation)
+      aggregators.should_not be_empty
+    end
+
+  end
+end

data/spec/test_examples.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+module Alf
+  describe "The examples" do
+    Alf::Doc.examples.each do |ex|
+      describe ex.source do
+
+        it 'runs without any problem on the examples database' do
+          Alf.examples.query(ex.source).should be_a(Relation)
+        end
+
+      end
+    end
+  end
+end

data/spec/test_to_html.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'alf/doc/to_html'
+module Alf
+  module Doc
+    describe ToHtml do
+
+      it 'works on an operator' do
+        op = Doc.query{ restrict(operators, name: "project") }.tuple_extract
+        lambda{
+          ToHtml.new.operator(op)
+        }.should_not raise_error
+      end
+
+      it 'works on a predicate' do
+        op = Doc.query{ restrict(predicates, name: "eq") }.tuple_extract
+        lambda{
+          ToHtml.new.predicate(op)
+        }.should_not raise_error
+      end
+
+      it 'works on a aggregator' do
+        op = Doc.query{ restrict(aggregators, name: "sum") }.tuple_extract
+        lambda{
+          ToHtml.new.aggregator(op)
+        }.should_not raise_error
+      end
+
+    end
+  end
+end

data/spec/test_to_markdown.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'alf/doc/to_markdown'
+module Alf
+  module Doc
+    describe ToMarkdown do
+
+      it 'works on an operator' do
+        op = Doc.query{ restrict(operators, name: "project") }.tuple_extract
+        lambda{
+          ToMarkdown.new.operator(op)
+        }.should_not raise_error
+      end
+
+      it 'works on a predicate' do
+        op = Doc.query{ restrict(predicates, name: "eq") }.tuple_extract
+        lambda{
+          ToMarkdown.new.predicate(op)
+        }.should_not raise_error
+      end
+
+      it 'works on a aggregator' do
+        op = Doc.query{ restrict(aggregators, name: "sum") }.tuple_extract
+        lambda{
+          ToMarkdown.new.aggregator(op)
+        }.should_not raise_error
+      end
+
+    end
+  end
+end

data/tasks/doc.rake

@@ -0,0 +1,2 @@
+desc "Recompiles all the doc"
+task :doc => [:txt, :man, :html]

data/tasks/gem.rake

@@ -0,0 +1,8 @@
+require 'rubygems/package_task'
+gemspec_file = File.expand_path('../../alf-doc.gemspec', __FILE__)
+gemspec      = Kernel.eval(File.read(gemspec_file))
+Gem::PackageTask.new(gemspec) do |t|
+  t.name = gemspec.name
+  t.version = gemspec.version
+  t.package_files = gemspec.files
+end

data/tasks/html.rake

@@ -0,0 +1,39 @@
+namespace :html do
+  require "alf/doc/to_html"
+
+  ROOT = Path.dir.parent
+  HTML = ROOT/'compiled/html'
+
+  desc "Generates all API in html"
+  task :api do
+    # API
+    (HTML/'api').mkdir_p
+    Alf::Doc.each_api do |kind, name, obj|
+      target = HTML/"api/#{name}.html"
+      puts "#{name} -> #{target}"
+      target.write Alf::Doc::ToHtml.new.send(kind, obj)
+    end
+  end
+
+  desc "Generates pages in HTML"
+  task :pages do
+    (HTML/'pages').mkdir_p
+    Alf::Doc.pages.each do |page|
+      target = HTML/"pages/#{page.rm_ext.basename}.html"
+      puts "#{page} -> #{target}"
+      target.write(Alf::Doc::ToHtml.new.page(page.read))
+    end
+  end
+
+  desc "Generates blog in HTML"
+  task :blog do
+    (HTML/'blog').mkdir_p
+    Alf::Doc.blog.each do |page|
+      target = HTML/"blog/#{page.rm_ext.basename}.html"
+      puts "#{page} -> #{target}"
+      target.write(Alf::Doc::ToHtml.new.page(page.read))
+    end
+  end
+end
+desc "Generates all HTML pages"
+task :html => [:"html:api", :"html:pages", :"html:blog"]

data/tasks/man.rake

@@ -0,0 +1,23 @@
+desc "Generate man pages"
+task :man do
+  MAN = Path.dir.parent/'compiled/man'
+  MAN.mkdir_p
+  require 'alf/doc/to_markdown'
+  require 'md2man'
+  require 'md2man/roff/engine'
+
+  # API
+  Alf::Doc.each_api do |kind, name, obj|
+    target = MAN/"#{name}.man"
+    puts "#{name} -> #{target}"
+    md = Alf::Doc::ToMarkdown.new.send(kind, obj)
+    target.write(Md2Man::Roff::ENGINE.render(md))
+  end
+
+  # COMMANDS
+  Alf::Doc.commands.each do |md|
+    target = MAN/"#{md.basename.rm_ext}.man"
+    puts "#{md} -> #{target}"
+    target.write(Md2Man::Roff::ENGINE.render(md.read))
+  end
+end

data/tasks/test.rake

@@ -0,0 +1,6 @@
+require "rspec/core/rake_task"
+desc "Run tests"
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = "spec/**/test_*.rb"
+  t.rspec_opts = ["--color"]
+end

data/tasks/txt.rake

@@ -0,0 +1,21 @@
+desc "Generate .txt pages"
+task :txt do
+  TXT = Path.dir.parent/'compiled/txt'
+  TXT.mkdir_p
+  require 'alf/doc/to_markdown'
+
+  # API
+  Alf::Doc.each_api do |kind, name, obj|
+    target = TXT/"#{name}.txt"
+    puts "#{name} -> #{target}"
+    md = Alf::Doc::ToMarkdown.new.send(kind, obj)
+    target.write(md.gsub(/^```(try)?\n/, ""))
+  end
+
+  # COMMANDS
+  Alf::Doc.commands.each do |md|
+    target = TXT/"#{md.basename.rm_ext}.man"
+    puts "#{md} -> #{target}"
+    target.write(md.read)
+  end
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: alf-doc
+version: !ruby/object:Gem::Version
+  version: 0.15.0
+  prerelease: 
+platform: ruby
+authors:
+- Bernard Lambeau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wlang
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: albino
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: md2man
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: alf-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+description: This gem provides support for using the formal documentation of Alf.
+email:
+- blambeau at gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- lib/alf/doc/loader.rb
+- lib/alf/doc/to_html.rb
+- lib/alf/doc/to_markdown.rb
+- lib/alf/doc/version.rb
+- lib/alf/doc/viewpoint.rb
+- lib/alf/doc.rb
+- lib/alf-doc.rb
+- LICENCE.md
+- Manifest.txt
+- Rakefile
+- README.md
+- spec/spec_helper.rb
+- spec/test_doc.rb
+- spec/test_examples.rb
+- spec/test_to_html.rb
+- spec/test_to_markdown.rb
+- tasks/doc.rake
+- tasks/gem.rake
+- tasks/html.rake
+- tasks/man.rake
+- tasks/test.rake
+- tasks/txt.rake
+homepage: http://github.com/blambeau/alf
+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'
+      segments:
+      - 0
+      hash: -2651068538456684489
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2651068538456684489
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Documentation of Alf relational algebra
+test_files: []