fox 0.0.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 814f5a6e5abc6ffd2eef794ba91812a6643294b4
-  data.tar.gz: 686b3443f7a26d29d11ca2fdec87aadc94c45045
+  metadata.gz: 958a7a559e25d833355bdf0fffd38dac5a54d6d6
+  data.tar.gz: af8ee1fde1f1f28701dce0549736b9e6f536f15d
 SHA512:
-  metadata.gz: b77d62f2e1b0027dd7b2c79c7cf64a81b5ad5cf9365c69149142c6c545a50e1887983df30d7470fdfa2c0d76b359f60282607e86fc1875c9f0d05422f352d547
-  data.tar.gz: 84c95f63f6867e0c6467a6b298210b4980d5d1dfd89b1cffd25013d543b0ffc759ad9b3f4ad2a0231cc30728b518697583f8eb633e74287033c6ac84751c6f71
+  metadata.gz: 587e812e9e989e5e936a3503af624fe4d4848b7243c679d23034076cbb9807a9b5f82f9b9e27f140c651f47bf50cbcc6a878949378826d4c038966c41498d2fd
+  data.tar.gz: de4e187eb5304bac91fffd4475ed344af4f05ea7305fa31eb0ea564d528d4baaa4136959f748db5e265ec5772750b00b60626e542fd435f0338acae6a6670328

data/README.md

@@ -1,9 +1,12 @@
 # Fox
-Version 0.0.1-1-g385406b
+Version 0.0.2-2-g78e0147
 
 [![Gem Version](https://badge.fury.io/rb/fox.svg)](http://badge.fury.io/rb/fox)
 [![License](http://img.shields.io/badge/license-GPLv3-brightgreen.svg)](http://img.shields.io/badge/license-GPLv3-brightgreen.svg)
 
+
+## WHAT IS THE FOX PROJECT?
+
 Fox [1] is a complete solution for scientific paper scaffolding, tooling and author support.  It
 allows the bootstrapping or generation of dummy default paper with a rails scaffold like commandline
 tool.
@@ -11,39 +14,63 @@ tool.
 Fox supports the configuration of various methods of pdf push to remote locations to allow for
 efficient file sharing with co-authors.
 
+Fox, currently supports only IEEE Robotics & Automation Society (ICRA) [2].
+
+[1] Paper Fox, named after an in similar spirit deviation from the german "papier tiger"
+[2] IEEE Robotics and Automation Society's flagship conference,  IEEE Robotics & Automation Society, http://icra2015.org/
 
-Fox, supports currently the following international journals:
 
- - None, TBD
+## FEATURES
 
-Fox, supports currently the following international conferences:
+- Application
+  - Ruby VM (2.1 or better)
+- Feature Providing Base Libraries
+  - RVM
+  - Bundler
+  - Datamapper ORM with SQLite3/MySQL
+  - Slim
+  - Various Gems (see Gemfile)
+- Development
+- Development Base Libraries
+  - Rake
+  - Thor
+- Code Quality
+  - Code review
+  - Yard & related  (gem install yard --no-ri --no-rdoc ; gem install rdiscount --no-ri --no-rdoc)
+  - Minimal controllers, delegated to proper Ruby classes
+  - Logic free view templates
+  - Proper Ruby OOP for base functionality
+  - MetricFu/RSpec/Cucumber/DBC/Vagrant/Docker/i18n
 
- - IEEE Robotics & Automation Society (ICRA) [2]
 
-Fox, supports currently the following domestic conferences:
+## ON WHAT HARDWARE DOES IT RUN?
 
- - None, TBD
+This Software was originally developed and tested on 32-bit x86 / SMP based PCs running on
+Gentoo GNU/Linux 3.12.x. Other direct Linux and Unix derivates should be viable too as
+long as all dynamical linking dependencys are met.
 
 
-[1] Paper Fox, named after an in similar spirit deviation from the german "papier tiger"
-[2] IEEE Robotics and Automation Society's flagship conference,  IEEE Robotics & Automation Society, http://icra2015.org/
+## DOCUMENTATION
 
+A general developers API guide can be extracted from the Yardoc subdirectory which is able to
+generate HTML as well as PDF docs. Please refer to the [Rake|Make]file for additional information
+how to generate this documentation.
 
-## Installing
+## INSTALLING
 
-By running gem comand
+By running gem comand (stable version)
 
 ```
 gem install fox
 ```
 
-or by adding to `Gemfile`
+or by adding to `Gemfile` (unstable version)
 
 ```ruby
-gem 'fox', git: 'https://github.com/rennhak/fox'
+gem 'fox', git: 'https://github.com/rennhak/fox', branch: 'develop'
 ```
 
-## Usage
+## USAGE
 
 As library
 
@@ -62,6 +89,161 @@ Commands:
   fox generate
 ```
 
+## DEVELOPMENT
+
+Get a copy of current source from SCM
+
+```sh
+~# git clone https://github.com/rennhak/fox
+```
+
+Install system dependencies (e.g. Debian/GNU)
+
+```sh
+~# apt-get install iconv
+~# apt-get install imagemagick libmagickcore-dev libmagickwand-dev libmagic1 libmagic-dev
+~# apt-get install curl screen less vim
+~# apt-get install zlib1g zlib1g-dev
+```
+
+Install RVM (may not apply)
+
+```sh
+~# curl -sSL https://get.rvm.io | bash -s stable
+```
+
+Make sure to follow install instructions and also integrate it also into your shell. e.g. for ZSH,
+add this line to your .zshrc.
+
+```sh
+[[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm" ;
+
+or
+
+~# echo "source /usr/local/rvm/scripts/rvm" >> ~/.zshrc
+
+```
+
+Create proper RVM gemset
+
+```sh
+~# rvm --create use 2.1.3@fox_project
+```
+
+Install Ruby VM 2.1.x or better
+
+```sh
+~# rvm install 2.1.3
+```
+
+Install libraries via bundler
+
+```sh
+~# gem install bundler
+~# bundle
+```
+
+Development uses SQLite3
+
+```sh
+~# apt-get install sqlite3 libsqlite3-dev
+```
+
+### BUILDING GEM
+
+```sh
+~# rake build
+```
+
+### INSTALLING GEM
+
+```sh
+~# gem install pkg/fox-X.X.X.gem
+```
+
+### SUBMIT TO RUBYGEMS.ORG
+
+```sh
+~# cd pkg
+~# gem push -V fox-X.X.X.gem
+```
+
+### CURRENTLY AVAILABLE RAKE TASKS
+
+For a full list of Rake tasks suported, use `rake -T`.
+
+rake build                  # Build fox-0.0.2.gem into the pkg directory
+rake cucumber:pretty        # Run Cucumber features
+rake cucumber:progress      # Run Cucumber features
+rake default                # Show the default task when executing rake without arguments
+rake docs:generate          # Generate Yardoc documentation for this project
+rake docs:graph             # Generate Yard Graphs for this project
+rake guard:default          # Execute Ruby Guard
+rake help                   # Shows the usage help screen
+rake install                # Build and install fox-0.0.2.gem into system gems
+rake man:build              # Build the manual pages
+rake man:clean              # Clean up from the built man pages
+rake measurement:benchmark  # When executing rake tasks measure elapsed time, used with other tasks
+rake measurement:profiling  # Run profiling over stack
+rake metric:metric          # Run metric fu for project
+rake package:clean          # Clean all files from pkg folder
+rake readme:all             # Generate proper README file from templates
+rake readme:subdirs         # Builds generates readme files in all sub-directories
+rake readme:topdir          # Generate top level README file from template
+rake release                # Create tag v0.0.2 and build and push fox-0.0.2.gem to Rubygems
+rake spec                   # RSpec Core Tasks
+rake todo                   # Look for TODO and FIXME tags in the code
+rake version                # Git Tag number of this repo
+
+
+
+### CURRENTLY AVAILABLE THOR TASKS
+
+For a full list of Thor tasks suported, use `thor -T`.
+
+default
+-------
+thor :build                  # build
+thor :clean                  # clean
+thor :default                # Show the default task when executing rake without arguments
+thor :docs:generate          # Generate Yardoc documentation for this project
+thor :docs:graph             # Generate Yard Graphs for this project
+thor :guard:default          # Execute Ruby Guard
+thor :help                   # Shows the usage help screen
+thor :install                # Build and install fox-0.0.2.gem into system gems
+thor :man:build              # Build the manual pages
+thor :man:clean              # Clean up from the built man pages
+thor :measurement:benchmark  # When executing rake tasks measure elapsed time, used with other tasks
+thor :measurement:profiling  # Run profiling over stack
+thor :metric:metric          # Run metric fu for project
+thor :package:clean          # Clean all files from pkg folder
+thor :readme:all             # Generate proper README file from templates
+thor :readme:subdirs         # Builds generates readme files in all sub-directories
+thor :readme:topdir          # Generate top level README file from template
+thor :release                # release
+thor :spec                   # Run RSpec code examples
+thor :todo                   # Look for TODO and FIXME tags in the code
+thor :version                # Git Tag number of this repo
+
+info
+----
+thor info:overview  # Shows system overview
+
+version
+-------
+thor version:show  # Show version of this app
+
+
+
+
+## IF SOMETHING GOES WRONG
+
+In case you enconter bugs which seem to be related to the package please check in
+the MAINTAINERS file for the associated person in charge and contact him or her directly. If
+there is no valid address then try to mail Bjoern Rennhak <bjoern AT clothesnetwork DOT com> to get
+some basic assistance in finding the right person in charge of this section of the project.
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/rennhak/fox/fork )

data/bin/fox

@@ -2,21 +2,41 @@
 
 # Make sure load path contains local + global
 $LOAD_PATH << '.'
-$LOAD_PATH << File.dirname( File.join( __FILE__, '../lib/' ) )
+$LOAD_PATH << 'lib'
+
+$LOAD_PATH << File.expand_path("#{File.expand_path('../..', __FILE__)}/lib/fox/messages")
+$LOAD_PATH << File.expand_path("#{File.expand_path('../..', __FILE__)}/lib/fox/service")
 
 # System includes
 require 'bundler'
+
+# Make Thor scripts debug-able, e.g. ruby -r debug -- Thorfile
 require 'thor' unless defined? Thor::Runner
+require 'thor/runner'
+
+# Development Mode?
+if ENV["FOX_ENV"] == "development"
+    require "simplecov"
+
+    # Ensure merging of subprocesses by giving them a special name
+    # SimpleCov.command_name ARGV.join(" ")
+    SimpleCov.command_name "Fox #{Process.pid}"
+
+    # Set the correct root folder for SimpleCov
+    SimpleCov.root File.join(File.expand_path(File.dirname(__FILE__)), "..")
+
+    # Start coverage
+    SimpleCov.start
+end # of if ENV
+
 
-# Custom includes
-require_relative '../lib/fox'
+# Fox::Runner.new( ARGV.dup ).execute!
+$thor_runner            = true
 
+require File.expand_path("#{File.expand_path('../..', __FILE__)}/lib/fox/cli")
 
-# @class      Fox executable
-# @brief      Main entry point for commandline execution
-class Default < Thor
-end # of class Default
+$thor_runner = true
+CLI.start
 
-Default.start( ARGV )
 
 # vim:ts=2:tw=100:wm=100:syntax=ruby

data/fox.gemspec

@@ -58,8 +58,6 @@ Gem::Specification.new do |spec|
 
   spec.files                += Dir.glob( 'spec/**/*' )
 
-  spec.files                += Dir.glob( 'thrift/**/*' )
-
   spec.files                += Dir.glob( 'data/**/*' )
 
   spec.files                += Dir.glob( 'documentation/**/*' )
@@ -68,6 +66,10 @@ Gem::Specification.new do |spec|
 
   spec.files                += Dir.glob( 'base/**/*' )
 
+  spec.files                += Dir.glob( 'lib/fox/template/*' )
+
+  spec.files                += Dir.glob( 'lib/thrift/**/*' )
+
   spec.test_files           += Dir.glob( 'test/**/*' )
   spec.test_files           += Dir.glob( 'spec/**/*' )
   spec.test_files           += Dir.glob( 'features/**/*' )
@@ -79,12 +81,48 @@ Gem::Specification.new do |spec|
 
   # General
   spec.add_runtime_dependency 'thor'
-  spec.add_runtime_dependency 'ruby-try', '~> 1.1.1'
+
+  # Package building
+  spec.add_runtime_dependency 'fpm'
 
   # Shell
   spec.add_runtime_dependency 'ptools'
   spec.add_runtime_dependency 'os'
 
+  # Database ORM (Persistent)
+  spec.add_runtime_dependency 'datamapper'
+  spec.add_runtime_dependency 'data_mapper'
+  spec.add_runtime_dependency 'dm-core'
+  spec.add_runtime_dependency 'dm-tags'
+  spec.add_runtime_dependency 'dm-migrations'
+  spec.add_runtime_dependency 'dm-types'
+  spec.add_runtime_dependency 'dm-enum'
+  spec.add_runtime_dependency 'dm-validations'
+  spec.add_runtime_dependency 'dm-timestamps'
+  spec.add_runtime_dependency 'dm-sqlite-adapter'
+  spec.add_runtime_dependency 'dm-do-adapter'
+
+  # Data RPCs and Messaging
+  spec.add_runtime_dependency 'msgpack'
+
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'mime-types'
+
+  # Data Exchange Containers/Parsing
+  spec.add_runtime_dependency 'oj'
+
+  # Caching
+  spec.add_runtime_dependency 'moneta'
+
+  # Mail
+  spec.add_runtime_dependency 'pony'
+
+  # l10n
+  spec.add_runtime_dependency 'gettext'
+
+  # Rest interface
+  spec.add_runtime_dependency 'rack'
+
   # Monadic/Functional
   spec.add_runtime_dependency 'andand'
   # spec.add_runtime_dependency 'ick'

data/lib/fox.rb

@@ -7,19 +7,32 @@ require 'rake'
 require 'ruby-try'
 
 
-# @class    Fox
-# @brief    Provides complete solution for scientific authoring
-class Fox
+# @module         module Fox
+# @brief          Fox modules and classes namespace
+module Fox
 
-  # @fn       def initialize {{{
-  # @brief    Default Constructor
-  def initialize
-  end # }}}
+    require_relative 'fox/version'
+    require_relative 'fox/error'
 
-end # of module Fox
+    # @module     module Mixin
+    # @brief      Mixin module contains various functions to be used in other components
+    module Mixin
+
+        # autoload :Guess, 'fox/mixin/'
+
+    end # of module Mixing
+
+    # autoload :Cache,      'fox/library/cache'
+    # autoload :Choice,     'fox/library/choice'
 
-# Load other library files
-Dir[ File.dirname(__FILE__) + '/fox/library/*.rb' ].each { |file| require file }
 
+    DEFAULT_CONFIG      = '.fox/config.yaml'.freeze
+
+    class << self
+    end # of class << self
+
+end # of module Fox
+
+Default.start
 
 # vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/fox/cli.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# System
+require "thor"
+
+# Custom
+require File.expand_path(File.dirname(__FILE__) + '/interface/thor/version')
+require File.expand_path(File.dirname(__FILE__) + '/interface/thor/configuration')
+
+
+class CLI < Thor
+
+  register(Version, 'version', 'version [something]', "Show current version")
+  register(Configuration, 'config', 'config [something]', "Type for work with fox config")
+
+end
+

data/lib/fox/configuration.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+# System
+require "yaml"
+
+
+module Fox
+
+  # @class      Configuration  
+  # @brief      Configuration control class
+  class Configuration
+
+    attr_accessor :project_name
+    attr_accessor :base_dir
+
+    # @fn         def initialize confguration_file # {{{
+    # @brief      Constructor for Configuration class
+    #
+    # @param      [String] - path to configuration file 
+    def initialize confguration_file = nil
+      configuration = if confguration_file
+        base_configuration.merge(YAML.load_file(confguration_file))
+      else
+        base_configuration
+      end
+
+      # @todo add a deep loop for inner key-value pair
+      configuration.each do |key, value|
+        # if Default configuration not contain property, then we should raise exception
+        raise Exception.new("Unexpected #{key} for Fox configuration") unless base_configuration.include?(key)
+        instance_variable_set(:"@#{key}", value)
+      end
+    end # of def initialize }}}
+
+    # @fn         def base_configuration {{{
+    # @brief      return default configuration for Fox
+    # @return     [Hash] 
+    def base_configuration 
+      {
+        "project_name" => "project-#{rand(100)}",
+        "base_dir"     => Dir.pwd
+      } 
+    end # of def base_configuration }}}
+
+  end # end of Configure class
+
+end # end of Fox module
+