rea 0.0.1

data/lib/rea/command/search.rb

@@ -0,0 +1,52 @@
+module Rea
+  class Command
+    #
+    # Search publications on the online libraries
+    #
+    # SYNOPSIS
+    #   #{command_name} [options] ARG
+    #
+    # OPTIONS
+    # #{summarized_options}
+    #
+    class Search < Quickl::Command(__FILE__, __LINE__)
+      include Utils
+
+      # Install options
+      options do |opt|
+        @provider = Rea::providers.first
+        @mainarg = :title
+        @query   = {}
+        Rea::providers.each do |p|
+          opt.on("--#{p.shortcut}", "Search on #{p.url}"){ 
+            @provider = p
+          }
+        end
+        opt.on("--title=[TITLE]", "Specify the publication title"){|title|
+          if title
+            @query[:title] = title
+          else
+            @mainarg = :title
+          end
+        }
+        @keep = nil
+        opt.on("--show=a,b,c", 
+               "Only show a, b, and c attributes", Array) do |list|
+          @keep = list.map(&:to_sym)
+        end
+      end
+
+      def run(*args)
+        puts pretty(super, @keep)
+      end
+
+      # Run the command
+      def execute(args)
+        raise Quickl::Help if args.size > 1
+        @query[@mainarg] = args.first if args.size == 1
+        @provider.search(@query)
+      end
+
+    end # class Search
+  end # class Command
+end # module Rea

data/lib/rea/command/utils.rb

@@ -0,0 +1,31 @@
+module Rea
+  class Command
+    module Utils
+
+      DEFAULT_INFO = {
+        :title   => "[Unknown title]",
+        :authors => ["[Unknown author]"],
+        :year    => "[Unknown year]",
+        :key     => "[Unknown key]",
+        :source  => "[Unknown source]",
+      }
+
+      def pretty(rel, keep = nil)
+        keep ||= [:code, :key, :author, :title, :year, :source]
+        Relation(rel).
+          defaults(DEFAULT_INFO).
+          extend(:authors => lambda{
+            authors.empty? ? ["[Unknown author]"] : authors
+          }).
+          extend(
+            :code   => lambda{ authors.first.split(/\s/).last + year.to_s },
+            :title  => lambda{ title[0..50]  },
+            :author => lambda{ authors.first }
+          ).project(keep)
+      rescue
+        Relation(rel).project(keep)
+      end
+
+    end # module Utils
+  end # class Command
+end # module Rea

data/lib/rea/errors.rb

@@ -0,0 +1,62 @@
+module Rea
+
+  class Error < StandardError
+    attr_reader :cause
+    def initialize(msg, cause = $!)
+      super(msg)
+      @cause = cause
+    end
+  end
+
+  class SystemError < Error
+  end
+  class ParseFormatError    < SystemError; end
+  class NotImplementedError < SystemError; end
+
+  class DomainError < Error
+  end
+  class ParseError      < DomainError; end
+  class NotFoundError   < DomainError; end
+  class ThirdPartyError < DomainError; end
+  class UsageError      < DomainError; end
+
+  module ErrorUtils
+
+    def error_message(msg, source = nil, cause = $!)
+      msg = msg.dup
+      msg << " #{source}" if source
+      msg << ", #{cause.message}" if cause
+      msg
+    end
+
+    def parse_error!(source)
+      msg = error_message("Error while parsing", source)
+      raise Rea::ParseError, msg
+    end
+
+    def third_party_error!(source)
+      msg = error_message("Error with third party service", source)
+      raise Rea::ThirdPartyError, msg
+    end
+
+    def not_found_error!(source)
+      msg = error_message("Unable to find", source)
+      raise Rea::NotFoundError, msg
+    end
+
+    def parse_format_error!(source)
+      msg = error_message("Unexpected parsing error (#{source})")
+      raise Rea::ParseFormatError, msg
+    end
+
+    def not_implemented_error!(msg)
+      raise Rea::NotImplementedError, msg
+    end
+
+    def unexpected_error!(source)
+      msg = error_message("Unexpected error (#{source})")
+      raise Rea::SystemError, msg
+    end
+
+  end
+end # module Rea

data/lib/rea/loader.rb

@@ -0,0 +1,8 @@
+require "http"
+require "nokogiri"
+require "quickl"
+require "pdf/toolkit"
+require "epath"
+require "alf"
+require "unicode"
+require "bibtex"

data/lib/rea/version.rb

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

data/lib/rea/work_key.rb

@@ -0,0 +1,33 @@
+module Rea
+  class WorkKey
+
+    attr_reader :provider
+    attr_reader :identifier
+
+    def initialize(provider, identifier)
+      @provider, @identifier = provider, identifier
+    end
+
+    def self.parse(str)
+      return str if str.is_a?(WorkKey)
+      unless str.strip =~ /^([a-z]+):\/\/(.+)$/
+        raise ArgumentError, "Invalid work key #{str}"
+      end
+      WorkKey.new($1, $2)
+    end
+
+    def ==(other)
+      other.is_a?(WorkKey) and other.to_s == to_s
+    end
+    alias :eql? :==
+
+    def to_s
+      "#{provider}://#{identifier}"
+    end
+
+    def to_ruby_literal
+      "Rea::WorkKey(#{to_s.inspect})"
+    end
+
+  end # class WorkKey
+end # module Rea

data/rea.gemspec

@@ -0,0 +1,192 @@
+# We require your library, mainly to have access to the VERSION number.
+# Feel free to set $version manually.
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require "rea/version"
+$version = Rea::Version.to_s
+
+#
+# This is your Gem specification. Default values are provided so that your library
+# should be correctly packaged given what you have described in the .noespec file.
+#
+Gem::Specification.new do |s|
+
+  ################################################################### ABOUT YOUR GEM
+
+  # Gem name (required)
+  s.name = "rea"
+
+  # Gem version (required)
+  s.version = $version
+
+  # A short summary of this gem
+  #
+  # This is displayed in `gem list -d`.
+  s.summary = "Research Exploring Assistant"
+
+  # A long description of this gem (required)
+  #
+  # The description should be more detailed than the summary.  For example,
+  # you might wish to copy the entire README into the description.
+  s.description = "Helper to build a mental map of a research topic."
+
+  # The URL of this gem home page (optional)
+  s.homepage = "https://github.com/blambeau/rea"
+
+  # Gem publication date (required but auto)
+  #
+  # Today is automatically used by default, uncomment only if
+  # you know what you do!
+  #
+  # s.date = Time.now.strftime('%Y-%m-%d')
+
+  # The license(s) for the library.  Each license must be a short name, no
+  # more than 64 characters.
+  #
+  # s.licences = %w{}
+
+  # The rubyforge project this gem lives under (optional)
+  #
+  # s.rubyforge_project = nil
+
+  ################################################################### ABOUT THE AUTHORS
+
+  # The list of author names who wrote this gem.
+  #
+  # If you are providing multiple authors and multiple emails they should be
+  # in the same order.
+  #
+  s.authors = ["Bernard Lambeau"]
+
+  # Contact emails for this gem
+  #
+  # If you are providing multiple authors and multiple emails they should be
+  # in the same order.
+  #
+  # NOTE: Somewhat strangly this attribute is always singular!
+  #       Don't replace by s.emails = ...
+  s.email  = ["blambeau@gmail.com"]
+
+  ################################################################### PATHS, FILES, BINARIES
+
+  # Paths in the gem to add to $LOAD_PATH when this gem is
+  # activated (required).
+  #
+  # The default 'lib' is typically sufficient.
+  s.require_paths = ["lib"]
+
+  # Files included in this gem.
+  #
+  # By default, we take all files included in the Manifest.txt file on root
+  # of the project. Entries of the manifest are interpreted as Dir[...]
+  # patterns so that lazy people may use wilcards like lib/**/*
+  #
+  here = File.expand_path(File.dirname(__FILE__))
+  s.files = File.readlines(File.join(here, 'Manifest.txt')).
+                 inject([]){|files, pattern| files + Dir[File.join(here, pattern.strip)]}.
+                 collect{|x| x[(1+here.size)..-1]}
+
+  # Test files included in this gem.
+  #
+  s.test_files = Dir["test/**/*"] + Dir["spec/**/*"]
+
+  # The path in the gem for executable scripts (optional)
+  #
+  s.bindir = "bin"
+
+  # Executables included in the gem.
+  #
+  s.executables = (Dir["bin/*"]).collect{|f| File.basename(f)}
+
+  ################################################################### REQUIREMENTS & INSTALL
+  # Remember the gem version requirements operators and schemes:
+  #   =  Equals version
+  #   != Not equal to version
+  #   >  Greater than version
+  #   <  Less than version
+  #   >= Greater than or equal to
+  #   <= Less than or equal to
+  #   ~> Approximately greater than
+  #
+  # Don't forget to have a look at http://lmgtfy.com/?q=Ruby+Versioning+Policies
+  # for setting your gem version.
+  #
+  # For your requirements to other gems, remember that
+  #   ">= 2.2.0"              (optimistic:  specify minimal version)
+  #   ">= 2.2.0", "< 3.0"     (pessimistic: not greater than the next major)
+  #   "~> 2.2"                (shortcut for ">= 2.2.0", "< 3.0")
+  #   "~> 2.2.0"              (shortcut for ">= 2.2.0", "< 2.3.0")
+  #
+
+  #
+  # One call to add_dependency('gem_name', 'gem version requirement') for each
+  # runtime dependency. These gems will be installed with your gem.
+  # One call to add_development_dependency('gem_name', 'gem version requirement')
+  # for each development dependency. These gems are required for developers
+  #
+  s.add_development_dependency("rake", "~> 0.9.2")
+  s.add_development_dependency("rspec", "~> 2.8.0")
+  s.add_dependency("http", "~> 0.1.0")
+  s.add_dependency("nokogiri", "~> 1.5")
+  s.add_dependency("quickl", "~> 0.4.2")
+  s.add_dependency("pdf-toolkit", "= 1.0.0.rc1")
+  s.add_dependency("epath", "~> 0.0.1")
+  s.add_dependency("alf", "~> 0.12.0")
+  s.add_dependency("bibtex-ruby", "~> 2.0")
+
+  # The version of ruby required by this gem
+  #
+  # Uncomment and set this if your gem requires specific ruby versions.
+  #
+  # s.required_ruby_version = ">= 0"
+
+  # The RubyGems version required by this gem
+  #
+  # s.required_rubygems_version = ">= 0"
+
+  # The platform this gem runs on.  See Gem::Platform for details.
+  #
+  # s.platform = nil
+
+  # Extensions to build when installing the gem.
+  #
+  # Valid types of extensions are extconf.rb files, configure scripts
+  # and rakefiles or mkrf_conf files.
+  #
+  s.extensions = []
+
+  # External (to RubyGems) requirements that must be met for this gem to work.
+  # It’s simply information for the user.
+  #
+  s.requirements = nil
+
+  # A message that gets displayed after the gem is installed
+  #
+  # Uncomment and set this if you want to say something to the user
+  # after gem installation
+  #
+  s.post_install_message = nil
+
+  ################################################################### SECURITY
+
+  # The key used to sign this gem.  See Gem::Security for details.
+  #
+  # s.signing_key = nil
+
+  # The certificate chain used to sign this gem.  See Gem::Security for
+  # details.
+  #
+  # s.cert_chain = []
+
+  ################################################################### RDOC
+
+  # An ARGV style array of options to RDoc
+  #
+  # See 'rdoc --help' about this
+  #
+  s.rdoc_options = []
+
+  # Extra files to add to RDoc such as README
+  #
+  s.extra_rdoc_files = Dir["README.md"] + Dir["CHANGELOG.md"] + Dir["LICENCE.md"]
+
+end

data/rea.noespec

@@ -0,0 +1,33 @@
+template-info:
+  name: "ruby"
+  version: 1.7.0
+  links:
+    source: https://github.com/blambeau/noe
+  manifest:
+    lib/__lower__/loader.rb:
+      safe-override: false
+variables:
+  lower:
+    rea
+  upper:
+    Rea
+  version:
+    0.0.1
+  summary: |-
+    Research Exploring Assistant
+  description: |-
+    Helper to build a mental map of a research topic.
+  authors:
+    - {name: Bernard Lambeau, email: blambeau@gmail.com}
+  links:
+    - https://github.com/blambeau/rea
+  dependencies:
+    - {name: http,        version: "~> 0.1.0",     groups: [runtime]}
+    - {name: nokogiri,    version: "~> 1.5",       groups: [runtime]}
+    - {name: quickl,      version: "~> 0.4.2",     groups: [runtime]}
+    - {name: pdf-toolkit, version: "= 1.0.0.rc1",  groups: [runtime]}
+    - {name: epath,       version: "~> 0.0.1",     groups: [runtime]}
+    - {name: alf,         version: "~> 0.12.0",    groups: [runtime]}
+    - {name: bibtex-ruby, version: "~> 2.0",       groups: [runtime]}
+    - {name: rake,        version: "~> 0.9.2",     groups: [development]}
+    - {name: rspec,       version: "~> 2.8.0",     groups: [development]}

data/spec/rea-dblp/fixtures/entries/Damas2005.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<dblp>
+<article key="journals/tse/DamasLDL05" mdate="2006-08-22">
+<author>Christophe Damas</author>
+<author>Bernard Lambeau</author>
+<author>Pierre Dupont</author>
+<author>Axel van Lamsweerde</author>
+<title>Generating Annotated Behavior Models from End-User Scenarios.</title>
+<pages>1056-1073</pages>
+<year>2005</year>
+<volume>31</volume>
+<journal>IEEE Trans. Software Eng.</journal>
+<number>12</number>
+<ee>http://doi.ieeecomputersociety.org/10.1109/TSE.2005.138</ee>
+<url>db/journals/tse/tse31.html#DamasLDL05</url>
+</article>
+</dblp>