opener-core 0.3.0 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YmJmZmE4YmQ3ZjdjOGJjNmZlMTE0MTQzNzQ5OTkxZjEyZDdlYjdlZA==
-  data.tar.gz: !binary |-
-    NDhkOTg4NTcxYTBjODY3OTg3NmViOGRkNGJjOGRkNzFhM2UxNmE5NQ==
+SHA1:
+  metadata.gz: 684400e699f1c6e57874760173a14c94867c778f
+  data.tar.gz: 232c9cc158ff147fffcff61a97442f1add08e7cd
 SHA512:
-  metadata.gz: !binary |-
-    ZTI0ZDc4OWRlZTE0Nzg3MTgzYzMzNTQzYmU2NmVjYjY4MmZhNzE2ZmEzM2Jl
-    MDcyZTIzMmM1ZTY5MTgyM2NjZjkxMTQxYzE4OTVhN2EzOGE4ZTM5ZjU0NzJi
-    YjBjYTViMzlhOGFkNmI1YTA3ZGQzN2JhMjJjYmIyNmM4MzBkNzY=
-  data.tar.gz: !binary |-
-    MzQ1ZjkzZDk2YjcyMTAyMDMwMmRhYzUwY2ZkZDVlZWNkMjBjNzIwMWQzODRj
-    NzgwOGE5NjFjMWQzZmU5OGYwNjU0MmEyNTM2ZjIwMDM2ZDYxZThiYzM2MGI1
-    N2UzYzU1YjZiMTZjMjYwZjkwYjQ0ZmNjM2EyMTFjYWJhMGIwYWI=
+  metadata.gz: 8e2e0c45f79e05d39f11add57e75a52ac13c3a39c023fcf0237e3792077ae89911c5289a7ef5d5bbf35792d43b0d5fcafbd1705b393cf081b82daf2a93fd183a
+  data.tar.gz: c41f0f6a35b60c3b3db02b4e305d014813cd06c7803841f37259985a0d41d351fee508af0311e6561e1fd7a81ac6366492b5d7a6d5186d595cb076c37ead5229

data/README.md

@@ -1,29 +1,27 @@
 # Opener::Core
 
-TODO: Write a gem description
+A Gem that provides commonly re-used functionality for the various OpeNER Gems.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+You can install opener-core as a Gem by running:
 
-    gem 'opener-core'
+    gem install opener-core
+
+If you're using Bundler you can add the following to your Gemfile:
 
-And then execute:
+    gem 'opener-core'
 
-    $ bundle
+Then run `bundle install` to install all the Gems.
 
-Or install it yourself as:
+## Development
 
-    $ gem install opener-core
+Assuming you have a local copy of this repository, first install all the Gems:
 
-## Usage
+    bundle install
 
-TODO: Write usage instructions here
+Then run the tests to make sure everything is working:
 
-## Contributing
+    rake
 
-1. Fork it ( http://github.com/<my-github-username>/opener-core/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
+You're now good to go!

data/lib/opener/core.rb

@@ -1,7 +1,12 @@
-require "opener/core/version"
+require 'benchmark'
+require 'optparse'
+require 'tempfile'
+require 'uri'
+require 'nokogiri'
 
-module Opener
-  module Core
-    # Your code goes here...
-  end
-end
+require_relative 'core/version'
+require_relative 'core/argv_splitter'
+require_relative 'core/opt_parser'
+require_relative 'core/resource_switcher'
+require_relative 'core/memory_usage'
+require_relative 'core/benchmark'

data/lib/opener/core/benchmark.rb

@@ -0,0 +1,146 @@
+module Opener
+  module Core
+    ##
+    # Class for measuring and adding benchmarking information to KAF documents.
+    #
+    # Basic usage is as following:
+    #
+    #     benchmark = Opener::Core::Benchmark.new('opener-property-tagger')
+    #     document  = nil
+    #     results   = benchmark.measure do
+    #       document = some_stuff_that_emits_kaf
+    #     end
+    #
+    #     # Add the data to the document. This method returns the new XML as a
+    #     # String.
+    #     xml = benchmark.write(document, results)
+    #
+    # ## Metrics
+    #
+    # The following metrics are gathered:
+    #
+    # * Starting memory usage
+    # * End memory usage
+    # * Memory increase (if any)
+    # * CPU system time
+    # * CPU user time
+    # * Real time
+    # * Total time
+    #
+    # @!attribute [r] name
+    #  @return [String]
+    #
+    # @!attribute [r] results
+    #  @return [Hash]
+    #
+    class Benchmark
+      attr_reader :name
+
+      ##
+      # @param [String] name The name of the benchmark.
+      #
+      def initialize(name)
+        @name = name
+      end
+
+      ##
+      # Measures the block and returns the results as a Hash.
+      #
+      # @example
+      #  measure do
+      #    sleep(5)
+      #  end
+      #
+      # @return [Hash]
+      #
+      def measure
+        mem_usage = MemoryUsage.new
+        mem_start = mem_usage.usage
+        timings   = ::Benchmark.measure do
+          yield
+        end
+
+        mem_end = mem_usage.usage
+
+        return {
+          :memory_start    => mem_start,
+          :memory_end      => mem_end,
+          :memory_increase => mem_end - mem_start,
+          :time_cpu_system => timings.stime,
+          :time_cpu_user   => timings.utime,
+          :time_real       => timings.real,
+          :time_total      => timings.total
+        }
+      end
+
+      ##
+      # Writes benchmarking results to the specified document.
+      #
+      # @param [String] xml The XML document.
+      # @param [Hash] results The benchmarking results to write.
+      # @return [String]
+      #
+      def write(xml, results)
+        document   = Nokogiri::XML(xml)
+        root       = document.at('KAF')
+        benchmarks = root.at('benchmarks')
+
+        unless benchmarks
+          benchmarks = Nokogiri::XML::Node.new('benchmarks', document)
+
+          root.add_child(benchmarks)
+        end
+
+        benchmark = create_benchmark_node(document)
+
+        results.each do |name, val|
+          benchmark.add_child(create_node(name, val, document))
+        end
+
+        benchmarks.add_child(benchmark)
+
+        return convert_document(document)
+      end
+
+      private
+
+      ##
+      # @param [Nokogiri::XML::Document] document
+      # @return [String]
+      #
+      def convert_document(document)
+        if document.encoding and !document.encoding.empty?
+          return document.to_xml
+        else
+          return document.to_xml(:encoding => 'UTF-8')
+        end
+      end
+
+      ##
+      # @param [Nokogiri::XML::Document] document
+      # @return [Nokogiri::XML::Node]
+      #
+      def create_benchmark_node(document)
+        node = Nokogiri::XML::Node.new('benchmark', document)
+
+        node.set_attribute('name', name)
+
+        return node
+      end
+
+      ##
+      # @param [String|Symbol] name
+      # @param [Mixed] text
+      # @param [Nokogiri::XML::Document] document
+      # @return [Nokogiri::XML::Node]
+      #
+      def create_node(name, text, document)
+        node = Nokogiri::XML::Node.new(name.to_s, document)
+
+        node.inner_html = text.to_s
+
+        return node
+      end
+    end # Benchmark
+  end # Core
+end # Opener

data/lib/opener/core/memory_usage.rb

@@ -0,0 +1,47 @@
+module Opener
+  module Core
+    ##
+    # Class for returning the memory usage of the current process. This uses
+    # the `/proc` filesystem if available and falls back to `ps`.
+    #
+    class MemoryUsage
+      ##
+      # Returns the RSS (aka total memory) in bytes.
+      #
+      # @return [Fixnum]
+      #
+      def usage
+        return has_proc? ? rss_proc : rss_ps
+      end
+
+      ##
+      # @return [TrueClass|FalseClass]
+      #
+      def has_proc?
+        return File.exists?('/proc')
+      end
+
+      ##
+      # Returns the RSS using the `/proc` filesystem.
+      #
+      # @return [Fixnum]
+      #
+      def rss_proc
+        kb = File.read('/proc/self/status').match(/VmRSS:\s+(\d+)/)[1].to_i
+
+        return kb * 1024
+      end
+
+      ##
+      # Returns the RSS using the `ps` command.
+      #
+      # @return [Fixnum]
+      #
+      def rss_ps
+        kb = `ps -o rss= #{Process.pid}`.strip.to_i
+
+        return kb * 1024
+      end
+    end # MemoryUsage
+  end # Core
+end # Opener

data/lib/opener/core/opt_parser.rb

@@ -1,5 +1,3 @@
-require 'optparse'
-
 module Opener
   module Core
     class OptParser

data/lib/opener/core/resource_switcher.rb

@@ -1,7 +1,3 @@
-require 'tempfile'
-require 'uri'
-require_relative 'opt_parser'
-
 module Opener
   module Core
     class ResourceSwitcher

data/lib/opener/core/version.rb

@@ -1,5 +1,5 @@
 module Opener
   module Core
-    VERSION = "0.3.0"
+    VERSION = '1.0.0'
   end
 end

data/opener-core.gemspec

@@ -1,14 +1,13 @@
-# coding: utf-8
 require File.expand_path('../lib/opener/core/version', __FILE__)
 
 Gem::Specification.new do |spec|
-  spec.name          = "opener-core"
+  spec.name          = 'opener-core'
   spec.version       = Opener::Core::VERSION
-  spec.authors       = ["development@olery.com"]
-  spec.summary       = %q{Gem that contains some low lever generic functions for all OpeNER components.}
+  spec.authors       = ['development@olery.com']
+  spec.summary       = 'Gem that contains some low level generic functions for all OpeNER components.'
   spec.description   = spec.summary
-  spec.homepage      = "http://opener-project.github.com"
-  spec.license       = "Apachev2"
+  spec.homepage      = 'http://opener-project.github.com'
+  spec.license       = 'Apachev2'
 
   spec.files = Dir.glob([
     'lib/**/*',
@@ -17,8 +16,10 @@ Gem::Specification.new do |spec|
   ]).select { |file| File.file?(file) }
 
   spec.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
-  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_dependency 'nokogiri'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

metadata

@@ -1,56 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: opener-core
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - development@olery.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-06-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Gem that contains some low lever generic functions for all OpeNER components.
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem that contains some low level generic functions for all OpeNER components.
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- lib/opener/core.rb
 - lib/opener/core/argv_splitter.rb
+- lib/opener/core/benchmark.rb
+- lib/opener/core/memory_usage.rb
 - lib/opener/core/opt_parser.rb
 - lib/opener/core/resource_switcher.rb
 - lib/opener/core/version.rb
-- lib/opener/core.rb
 - opener-core.gemspec
-- README.md
 homepage: http://opener-project.github.com
 licenses:
 - Apachev2
@@ -61,18 +91,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Gem that contains some low lever generic functions for all OpeNER components.
+summary: Gem that contains some low level generic functions for all OpeNER components.
 test_files: []
+has_rdoc: