RubyGems - ontology - Versions diffs - 0.0.1 - Mend

ontology 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

data/LICENSE +19 -0
data/NEWS.md +7 -0
data/README.md +36 -0
data/bin/ontology +83 -0
data/doc/Change_Log_txt.html +97 -0
data/doc/Gemfile.html +93 -0
data/doc/LICENSE.html +111 -0
data/doc/Object.html +230 -0
data/doc/Ontology.html +791 -0
data/doc/Ontology/Leaf.html +370 -0
data/doc/bin/ontology.html +193 -0
data/doc/created.rid +17 -0
data/doc/images/add.png +0 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +88 -0
data/doc/js/darkfish.js +153 -0
data/doc/js/jquery.js +18 -0
data/doc/js/navigation.js +142 -0
data/doc/js/search.js +94 -0
data/doc/js/search_index.js +1 -0
data/doc/js/searcher.js +228 -0
data/doc/rdoc.css +543 -0
data/doc/table_of_contents.html +110 -0
data/lib/ontology.rb +11 -0
data/lib/ontology/error_message.rb +17 -0
data/lib/ontology/leaf.rb +57 -0
data/lib/ontology/load_config_yaml.rb +13 -0
data/lib/ontology/make_glossary.rb +128 -0
data/lib/ontology/write_file.rb +10 -0
data/lib/ontology/yaml_utils.rb +74 -0
data/ontology.gemspec +32 -0
data/spec/config.yaml +3 -0
data/spec/decompose_md_file_spec.rb +417 -0
data/spec/leaf_spec.rb +13 -0
data/spec/test.md +5 -0
data/spec/test_make_glossary.rb +68 -0
data/spec/write_md_file_spec.rb +23 -0
data/spec/yaml_utils_spec.rb +39 -0
metadata +109 -0

data/doc/table_of_contents.html ADDED

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<title>Table of Contents - RDoc Documentation</title>
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+<body class="indexpage">
+<h1>Table of Contents - RDoc Documentation</h1>
+<h2>Pages</h2>
+<ul>
+  <li class="file">
+    <a href="Change_Log_txt.html">Change_Log</a>
+  </li>
+    <li class="file">
+    <a href="Gemfile.html">Gemfile</a>
+  </li>
+    <li class="file">
+    <a href="LICENSE.html">LICENSE</a>
+  </li>
+    <li class="file">
+    <a href="bin/ontology.html">ontology</a>
+  </li>
+</ul>
+<h2 id="classes">Classes/Modules</h2>
+<ul>
+  <li class="module">
+    <a href="Ontology.html">Ontology</a>
+  </li>
+    <li class="class">
+    <a href="Ontology/Leaf.html">Ontology::Leaf</a>
+  </li>
+    <li class="class">
+    <a href="Object.html">Object</a>
+  </li>
+</ul>
+<h2 id="methods">Methods</h2>
+<ul>
+    <li class="method"><a href="Ontology/Leaf.html#method-c-new">::new &mdash; Ontology::Leaf</a>
+    <li class="method"><a href="Ontology.html#method-i-any_language_ize">#any_language_ize &mdash; Ontology</a>
+    <li class="method"><a href="Ontology.html#method-i-build_glossary">#build_glossary &mdash; Ontology</a>
+    <li class="method"><a href="Ontology.html#method-i-check_config_yaml">#check_config_yaml &mdash; Ontology</a>
+    <li class="method"><a href="Ontology/Leaf.html#method-i-correct_yaml">#correct_yaml &mdash; Ontology::Leaf</a>
+    <li class="method"><a href="Ontology.html#method-i-decompose_as_multi_lang_md">#decompose_as_multi_lang_md &mdash; Ontology</a>
+    <li class="method"><a href="Ontology.html#method-i-decompose_as_yaml_conf">#decompose_as_yaml_conf &mdash; Ontology</a>
+    <li class="method"><a href="Ontology.html#method-i-error_message">#error_message &mdash; Ontology</a>
+    <li class="method"><a href="Ontology.html#method-i-error_message_abort">#error_message_abort &mdash; Ontology</a>
+    <li class="method"><a href="Ontology/Leaf.html#method-i-export_markdowns">#export_markdowns &mdash; Ontology::Leaf</a>
+    <li class="method"><a href="Object.html#method-i-f">#f &mdash; Object</a>
+    <li class="method"><a href="Ontology.html#method-i-generate_leaf_init_struct">#generate_leaf_init_struct &mdash; Ontology</a>
+    <li class="method"><a href="Ontology/Leaf.html#method-i-generate_markdown_file">#generate_markdown_file &mdash; Ontology::Leaf</a>
+    <li class="method"><a href="Ontology/Leaf.html#method-i-inspect">#inspect &mdash; Ontology::Leaf</a>
+    <li class="method"><a href="Ontology.html#method-i-iterate_yaml_part">#iterate_yaml_part &mdash; Ontology</a>
+    <li class="method"><a href="Ontology.html#method-i-load_config_pars">#load_config_pars &mdash; Ontology</a>
+    <li class="method"><a href="Ontology.html#method-i-symbolize_for_this_key">#symbolize_for_this_key &mdash; Ontology</a>
+    <li class="method"><a href="Ontology.html#method-i-to_symbol">#to_symbol &mdash; Ontology</a>
+    <li class="method"><a href="Ontology.html#method-i-treat_glossary_file">#treat_glossary_file &mdash; Ontology</a>
+    <li class="method"><a href="Ontology.html#method-i-type_of_leaf_part">#type_of_leaf_part &mdash; Ontology</a>
+    <li class="method"><a href="Ontology.html#method-i-write_md_file">#write_md_file &mdash; Ontology</a>
+</ul>
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>

data/lib/ontology.rb ADDED

@@ -0,0 +1,11 @@
+# encoding: utf-8
+module Ontology
+  require 'ontology/yaml_utils'
+  require 'ontology/leaf'
+  require 'ontology/make_glossary'
+  require 'ontology/load_config_yaml'
+  require 'ontology/error_message'
+  require 'ontology/write_file'
+end

data/lib/ontology/error_message.rb ADDED

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module Ontology
+  def error_message_abort(msg, exception = nil)
+    STDERR.puts msg
+    if exception
+      raise exception
+    end
+    exit 1
+  end
+  def error_message(msg, exception = nil)
+    STDERR.puts msg
+    if exception
+      raise exception
+    end
+  end
+end

data/lib/ontology/leaf.rb ADDED

@@ -0,0 +1,57 @@
+# encoding: utf-8
+module Ontology
+  class Leaf
+    attr_reader :my_hash
+    def inspect
+      ["Leaf.inspect", @my_hash.inspect]
+    end
+    def correct_yaml(languages)
+      #puts "correct_yaml #{languages}, #{languages.class}"
+      (languages + [:any]).each{|lng|
+         unless @my_hash[lng].nil?
+           @my_hash[:title] ||= Hash.new(&Lang_block)
+           @my_hash[:title][lng] = @my_hash[lng]
+           #@my_hash[:order] ||= {}
+           #@my_hash[:order][lng.first] = @my_hash[lng.first]
+           @my_hash.delete(lng)
+         end
+       }
+       any_language_ize(@my_hash, :title)
+       any_language_ize(@my_hash, :order)
+    end
+    def initialize hash_struct, glossary_as_symb
+      @my_hash = hash_struct
+      @glossary_as_symb = glossary_as_symb
+      #puts '****************!!', @my_hash
+      correct_yaml $data_symb[:ontology][@glossary_as_symb][:destination].keys
+      #puts '****************!!!!!', @my_hash
+    end
+    def generate_markdown_file lang, dir
+      begin
+        file_name = Base_dir + '/' + dir + '/_' + (@my_hash[:order][lang].to_url) + '.md'
+        #puts file_name
+        #puts @my_hash[:title][lang]  #,  @my_hash[:content][0][lang]
+        file_content = '##' + @my_hash[:title][lang] + "\n\n"
+        @my_hash[:content].each {|leaf_part| file_content << leaf_part[lang]+ "\n\n"}
+        if $options[:build]
+          write_md_file(file_name, file_content)
+        else
+          puts "write to #{file_name}"
+          #puts "content: ", file_content
+        end
+      rescue
+        STDERR.puts 'Aborting'
+        puts self.inspect
+        exit 1
+      end
+    end
+    def export_markdowns
+      $data_symb[:ontology][@glossary_as_symb][:destination].each {|lng, dir |
+        #puts lng, "export_markdowns #{lng},  #{dir} "
+        generate_markdown_file lng, dir
+      }
+    end
+  end
+end

data/lib/ontology/load_config_yaml.rb ADDED

@@ -0,0 +1,13 @@
+# encoding: utf-8
+module Ontology
+  def load_config_pars(str)
+    data = YAML.load(str)
+    $data_symb = to_symbol(data)
+    symbolize_for_this_key($data_symb, :default_language)
+    check_config_yaml
+  end
+  def check_config_yaml
+    error_message_abort("The configuration file #{$options[:config_file]} has been found, however it does not have an ontology section. Ontology cannot work, Aborting !") unless $data_symb[:ontology]
+    error_message_abort("No languages defined under ontology: languages: . Ontology cannot work, Aborting !")  if $data_symb[:ontology][:languages].nil?
+  end
+end

data/lib/ontology/make_glossary.rb ADDED

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+require 'yaml'
+require 'stringex'
+module Ontology
+  # type_of_leaf_part returns one of the following:
+  #
+  # * :is_yaml_conf
+  # * :is_multi_lang_md
+  # * :is_md
+  #
+  # This choice is done by successive tests
+  #
+  def type_of_leaf_part(str)
+    begin
+      decompose_as_yaml_conf(str)
+      return :is_yaml_conf
+    rescue
+      begin
+        decompose_as_multi_lang_md(str)
+        return :is_multi_lang_md
+      rescue
+        return :is_md
+      end
+    end
+  end
+  def decompose_as_yaml_conf(str)
+#    begin  ??????????????????????????????????????
+#      puts "before!!!!!!!!!!!!!!decompose_as_yaml_conf #{str}"
+      wrk_yaml = YAML.load(str)
+#    rescue
+      puts "****!!!!!!!!!!!!!!decompose_as_yaml_conf #{str}"
+#    end
+    raise "not a yaml"  unless wrk_yaml.class == Hash
+    to_symbol(wrk_yaml, Def_List.clone)
+  end
+  def decompose_as_multi_lang_md(str)
+    list_of_language_parts = str.scan(/\[(\w+)\](.*?)(?=(\[(\w+)\]|\z))/m)
+#    puts "decompose_as_multi_lang_md", str, '!!!!!!!!!!!!!!!!!!!!!!', list_of_language_parts, '!!!!!!!!!!!!!', list_of_language_parts.length
+    raise "not multi-language" if list_of_language_parts.length == 0
+    list_of_language_parts.inject(Hash.new(&Lang_block)){|result, arg| result[arg[0].to_sym] = arg[1]; result}
+  end
+  def iterate_yaml_part(file_as_str)
+#    list_of_yaml_files = file_as_str.scan(/^---$(.*?)(?=(^---$|\z))/m)  initial version
+#    list_of_yaml_files = file_as_str.scan(/^---[\f\t ]*$(.*?)(?=(^---[\f\t ]*$|\z))/m)     better
+    list_of_yaml_files = file_as_str.scan(/^---[\f\t ]*$(.*?)(?=(^---[\f\t ]*$|\z))/m)
+    #puts '***', list_of_yaml_files.class, list_of_yaml_files.length, list_of_yaml_files.inspect
+    list_of_yaml_files.each {|elt|
+      #puts "test ===  #{/\A[\f\t \r]*\z/m  =~ elt[0]} , #{elt[0]}"
+      yield elt[0] unless /\A[\s\t\r\n\f]*\z/m  =~ elt[0]
+    }
+  end
+  def generate_leaf_init_struct(file_as_str)
+    elt_ant = nil
+    iterate_yaml_part(file_as_str) {|str_elt|
+      begin
+        begin
+          x_elt_ant = decompose_as_yaml_conf(str_elt)
+          unless elt_ant.nil?
+            #puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!yield"
+            yield elt_ant
+            elt_ant = nil
+          end
+          elt_ant = x_elt_ant
+          elt_ant[:content] = []
+        rescue
+          begin
+            mark_down = decompose_as_multi_lang_md(str_elt)
+          rescue
+            mark_down = Hash.new(&Lang_block)
+            mark_down[:any] = str_elt
+          end
+          elt_ant[:content] << mark_down
+        end
+      rescue
+        STDERR.puts "Aborting:"
+        puts file_as_str
+        exit 1
+      end
+    }
+    unless elt_ant.nil?
+      yield elt_ant
+    end
+  end
+  def treat_glossary_file(fname, gloss_symb)
+    file = File.open(fname, 'rb')
+    content = file.read
+    content.force_encoding("UTF-8")
+    generate_leaf_init_struct(content){|hash_struct|
+      leaf = Leaf.new(hash_struct, gloss_symb)
+      leaf.export_markdowns
+    }
+  end
+  # ?? test_file = '/Users/mathias/Server/Projets/mflu_nanoc/mflu/work-progs/glossary/secondary-currency.md'
+  def build_glossary(gloss_symbol)
+    gloss_dir = $data_symb[:ontology][gloss_symbol][:source]
+    Dir.foreach(gloss_dir) {  |f|
+      unless (f == '.') or (f == '..')
+        full_file_name = Base_dir + '/' + gloss_dir +'/' + f
+        #puts full_file_name
+        treat_glossary_file full_file_name, gloss_symbol #?? if full_file_name == test_file
+      end
+    }
+  end
+end
+#File.open(fname) { |yf|
+#  YAML::load_documents(yf) { | yd|
+#    puts = '******'
+#    puts yd.inspect
+#  }
+#}
+#/^---$([.\n]*?)^---$/
+#st.scan(/^---$(.*?)(?=(^---$|\z))/){|x| puts "** #{x}”}
+#  x = content.scan(/^---$(.*?)(?=(^---$|\z))/) {|st|

data/lib/ontology/write_file.rb ADDED

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module Ontology
+  def write_md_file(name, content)
+#    puts "#{name} with content #{content} will be written"
+    f = File.open(name, 'wb')
+    f.write(content)
+    f.close
+  end
+end

data/lib/ontology/yaml_utils.rb ADDED

@@ -0,0 +1,74 @@
+# encoding: utf-8
+module Ontology
+# remplacé par Main_block et Lang_block !!!
+# The hash structures introduces a more complex default hierarchy than Hash by default. Aprt from that there are no differences.
+#hierarchy of replies:
+# * highest level: the ke value pair is defined
+# * a specific default key is defined, ie. if the original key-value pair is not supplied if for this key a specific default key is provided, it will be used
+# * a default key is defined, ie. the default key is used everytime the requested key-value pair is not defined
+# * default ie a default value is defined like for the original Hash class. It will be used if a given key or default_key or specific_default_key does not provide a value
+  Lang_block = Proc.new {|hash, lang|  if hash.keys.include?(:any) then hash[:any] end}
+  Main_block = Proc.new {|hash, arg|  if hash.keys.include?(:title) and arg == :order then hash[:title] end}
+  Def_List =  [Main_block, Lang_block]
+  #to_symbol converts a hash (of hash's) in the same strcuture replacing string keys by symbol. The routine is recursive
+  def to_symbol(x, hash_default_list = nil)
+    if x.class == Hash
+      if ! hash_default_list.nil? && hash_default_list.class == Array && hash_default_list.length > 0
+        default_function = hash_default_list[0]
+        new_default_list = hash_default_list[1, 100]
+        unless new_default_list.length > 0
+          new_default_list = nil
+        end
+        hash_used = Hash.new(&default_function)
+      else
+        hash_used = Hash.new()
+        new_default_list = nil
+      end
+      result = x.inject(hash_used) {|result, arg|
+        if arg.last.class == Hash || arg.last.class == Array
+          result[arg.first.to_sym] = to_symbol(arg.last, new_default_list);
+        else
+          result[arg.first.to_sym] = arg.last;
+        end
+        result}
+    elsif x.class == Array
+      begin
+        result = x.inject([]) {|res, elt| raise '' unless elt.class == String; res << elt.to_sym}
+      rescue
+        result = x
+      end
+    else
+      result = x
+    end
+    result
+  end
+  def symbolize_for_this_key(tree, this_key)
+    if tree.class == Hash
+      tree.each {|key, val|
+        if key == this_key and val.class == String then
+          tree[this_key] = val.to_sym
+        end
+        if val.class == Hash then
+          symbolize_for_this_key(val, this_key)
+        end
+      }
+    end
+  end
+  def any_language_ize(leaf, key_as_symbol)
+    leaf.each{|key, val| if key == key_as_symbol and val.class == String then
+      h = Hash.new(&Lang_block)
+      h[:any] = val
+      leaf[key] = h
+    end
+    }
+  end
+end

data/ontology.gemspec ADDED

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require 'rubygems'
+$LOAD_PATH.unshift(File.expand_path('../lib/', __FILE__))
+require 'ontology'
+Gem::Specification.new do |s|
+  s.name = "ontology"
+  s.version = "0.0.1"
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Mathias Foehr']
+  s.email = 'mf_tech@mathiasfoehr.lu'
+  s.homepage = 'http://mathiasfoehr.lu/ontology'
+  s.description = 'ontology structures (e.g. toc, glossaries,..) in an (if necessary multi-language Nanoc) static web site '
+  s.summary = s.description
+  s.rubyforge_project = 'ontology'
+  s.date = %q{2012-08-14}
+  s.require_paths << 'lib'
+  s.bindir = 'bin'
+  s.executables << 'ontology'
+  s.files = ['README.md', 'NEWS.md', 'LICENSE', 'lib/ontology.rb', 'bin/ontology']  +
+            Dir['{lib,spec}/**/*'] +
+            Dir['doc/**/*'] +
+            [ 'ontology.gemspec' ]
+  s.has_rdoc = true
+#  s.add_runtime_dependancy( 'stringex')
+end