hitimes 1.2.6 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50d7f140e090285423902516acfdb1853aaee2e9
-  data.tar.gz: ccf795402dde6d695663595409b1aaeace2867d9
+  metadata.gz: 7f524a821dc9c99b61be2c3af977e825f9ca7ed2
+  data.tar.gz: ff3e5a216ba2b504f49dd13d612b843c48855bd3
 SHA512:
-  metadata.gz: 351917724348a7cd51eb1bd67edbe1369797956c98708801ab8c61d8699cc8f2efff7fd3724a429a837184ef5caf031d76f70bf4c86a55661b075aac037171cb
-  data.tar.gz: 478abe6d82eb9898b6ea1e54cafe560b59a69e2c0b5b572d749bb6a2dff0f95e1ec8ee2e024d904c9c27c4f8f6f1f5640b777e91461b859a664687479b472caa
+  metadata.gz: bcf7ba65f863b4ed3376a42ab9adac359ccd751a8b9f97ac3c606792cef80ece1325590e5eda9580da15f84e7817af4c4a8b80e444f7a8e85725e2e93a77f67f
+  data.tar.gz: 1d25a2c4afedaaa53aed97ad47197121227aab88dbba57faa6ffc32566454617b2821f42289ca63c3dda0dc6c131c81e400aa1e6746f01dfc7b2fef75567b8ce

data/HISTORY.md

@@ -1,4 +1,10 @@
 # Hitimes Changelog
+## Version 1.3.0 2018-06-15
+
+* Add api method `Hitimes.raw_instant` to expose raw OS instant value
+* Add api constant `Hitimes::INSTANT_CONVERSION_FACTOR` to expose raw OS instant conversion factor
+* other development cleanup tasks
+
 ## Version 1.2.6 2017-08-04
 
 * Resolve version number issue (#61) (thanks @anthraxx)

data/README.md

@@ -1,5 +1,7 @@
 # Hitimes
 
+[![Build Status](https://travis-ci.org/copiousfreetime/hitimes.svg?branch=master)](https://travis-ci.org/copiousfreetime/hitimes)
+
 A fast, high resolution timer library for recording peformance metrics.
 
 * [Homepage](http://github.com/copiousfreetime/hitimes)
@@ -15,6 +17,7 @@ A fast, high resolution timer library for recording peformance metrics.
 * [Support](#support)
 * [License](#license)
 
+
 ## Requirements
 
 Hitimes requires the following to run:

data/ext/hitimes/c/hitimes.c

@@ -5,6 +5,20 @@
 VALUE mH;           /* module Hitimes            */
 VALUE eH_Error;     /* class  Hitimes::Error     */
 
+
+/**
+ * call-seq:
+ *    Hitimes.raw_instant -> Integer
+ *
+ * Return the raw instant value from the operating system
+ */
+VALUE hitimes_instant_raw( )
+{
+    unsigned long long i = (unsigned long long)hitimes_get_current_instant( );
+
+    return ULL2NUM(i);
+}
+
 /*
  * Document-class: Hitimes::Error
  *
@@ -13,8 +27,10 @@ VALUE eH_Error;     /* class  Hitimes::Error     */
 void Init_hitimes( )
 {
     mH = rb_define_module("Hitimes");
-     
+
     eH_Error = rb_define_class_under(mH, "Error", rb_eStandardError);
+    rb_define_const( mH, "INSTANT_CONVERSION_FACTOR", DBL2NUM( HITIMES_INSTANT_CONVERSION_FACTOR ));
+    rb_define_module_function( mH, "raw_instant", hitimes_instant_raw, 0 );
 
     Init_hitimes_interval();
     Init_hitimes_stats( );

data/ext/hitimes/java/src/hitimes/Hitimes.java

@@ -4,7 +4,10 @@ import java.lang.Math;
 import java.lang.System;
 
 import org.jruby.anno.JRubyClass;
+import org.jruby.anno.JRubyMethod;
 import org.jruby.anno.JRubyModule;
+import org.jruby.anno.JRubyConstant;
+import org.jruby.runtime.Visibility;
 
 import org.jruby.Ruby;
 import org.jruby.RubyClass;
@@ -14,6 +17,8 @@ import org.jruby.RubyObject;
 
 import org.jruby.exceptions.RaiseException;
 
+import org.jruby.runtime.builtin.IRubyObject;
+
 
 /**
  * @author <a href="mailto:jeremy@hinegardner.org">Jeremy Hinegardner</a>
@@ -21,12 +26,18 @@ import org.jruby.exceptions.RaiseException;
 @JRubyModule( name = "Hitimes" )
 public class Hitimes {
 
+    public static final double INSTANT_CONVERSION_FACTOR = 1000000000d;
+
+    private static final Ruby __ruby__ = Ruby.getGlobalRuntime();
+
     public static RubyClass hitimesIntervalClass;
     /**
      * Create the Hitimes module and add it to the Ruby runtime.
      */
-    public static RubyModule createHitimes( Ruby runtime ) {
+    public static RubyModule createHitimesModule( Ruby runtime ) {
         RubyModule mHitimes = runtime.defineModule("Hitimes");
+        mHitimes.defineConstant("INSTANT_CONVERSION_FACTOR", __ruby__.newFloat(INSTANT_CONVERSION_FACTOR));
+        mHitimes.defineAnnotatedMethods( Hitimes.class );
 
         RubyClass  cStandardError = runtime.getStandardError();
         RubyClass  cHitimesError  = mHitimes.defineClassUnder("Error", cStandardError, cStandardError.getAllocator());
@@ -47,8 +58,9 @@ public class Hitimes {
     }
 
 
-
-    @JRubyClass( name = "Hitimes::Error", parent = "StandardError" )
-    public static class Error {};
+    @JRubyMethod( name = "raw_instant", module = true )
+    public static IRubyObject rawInstant(IRubyObject self) {
+      return __ruby__.newFixnum( System.nanoTime() );
+    }
 
 }

data/ext/hitimes/java/src/hitimes/HitimesInterval.java

@@ -16,11 +16,6 @@ import org.jruby.anno.JRubyMethod;
 @JRubyClass( name = "Hitimes::Interval" )
 public class HitimesInterval extends RubyObject {
 
-    /* this is a double to force all division by the conversion factor
-     * to cast to doubles
-     */
-    private static final double INSTANT_CONVERSION_FACTOR = 1000000000d;
-
     private static final long   INSTANT_NOT_SET  = Long.MIN_VALUE;
     private static final double DURATION_NOT_SET = Double.NaN;
 
@@ -58,7 +53,7 @@ public class HitimesInterval extends RubyObject {
          * if stop has not yet been called, then return the amount of time so far
          */
         if ( INSTANT_NOT_SET == this.stop_instant ) {
-            double d = ( System.nanoTime() - this.start_instant ) / INSTANT_CONVERSION_FACTOR;
+            double d = ( System.nanoTime() - this.start_instant ) / Hitimes.INSTANT_CONVERSION_FACTOR;
             return getRuntime().newFloat( d );
         }
 
@@ -66,7 +61,7 @@ public class HitimesInterval extends RubyObject {
          * if stop has been called, then calculate the duration and return
          */
         if ( DURATION_NOT_SET == this.duration ) {
-            this.duration = (this.stop_instant - this.start_instant) / INSTANT_CONVERSION_FACTOR;
+            this.duration = (this.stop_instant - this.start_instant) / Hitimes.INSTANT_CONVERSION_FACTOR;
         }
 
         return getRuntime().newFloat( this.duration );
@@ -82,7 +77,7 @@ public class HitimesInterval extends RubyObject {
         }
 
         if ( INSTANT_NOT_SET == this.stop_instant ) {
-            double d = ( System.nanoTime() - this.start_instant ) / INSTANT_CONVERSION_FACTOR;
+            double d = ( System.nanoTime() - this.start_instant ) / Hitimes.INSTANT_CONVERSION_FACTOR;
             return getRuntime().newFloat( d );
         }
 
@@ -140,7 +135,7 @@ public class HitimesInterval extends RubyObject {
 
         if ( INSTANT_NOT_SET == this.stop_instant ) {
             this.stop_instant = System.nanoTime();
-            this.duration = (this.stop_instant - this.start_instant) / INSTANT_CONVERSION_FACTOR;
+            this.duration = (this.stop_instant - this.start_instant) / Hitimes.INSTANT_CONVERSION_FACTOR;
             return getRuntime().newFloat( this.duration );
         }
 

data/ext/hitimes/java/src/hitimes/HitimesService.java

@@ -8,7 +8,7 @@ import org.jruby.runtime.load.BasicLibraryService;
 
 public class HitimesService implements BasicLibraryService {
     public boolean basicLoad( final Ruby runtime ) throws IOException {
-        Hitimes.createHitimes( runtime );
+        Hitimes.createHitimesModule( runtime );
         return true;
     }
 }

data/lib/hitimes/version.rb

@@ -4,5 +4,5 @@
 #++
 
 module Hitimes
-  VERSION = "1.2.6"
+  VERSION = "1.3.0"
 end

data/spec/hitimes_spec.rb

@@ -11,4 +11,14 @@ describe Hitimes do
   it "raises an error if measure is called with no block" do
     lambda{ Hitimes.measure }.must_raise( Hitimes::Error )
   end
+
+  it "has the raw instant value" do
+    v = Hitimes.raw_instant
+    v.must_be :>, 0
+  end
+
+  it "has access to the instant conversion factor" do
+    f = Hitimes::INSTANT_CONVERSION_FACTOR
+    f.must_be :>, 0
+  end
 end

data/tasks/default.rake

@@ -24,7 +24,7 @@ namespace :develop do
     File.open( "Gemfile", "w+" ) do |f|
       f.puts "# DO NOT EDIT - This file is automatically generated"
       f.puts "# Make changes to Manifest.txt and/or Rakefile and regenerate"
-      f.puts 'source "https://rubygems.org/"'
+      f.puts 'source "https://rubygems.org"'
       f.puts 'gemspec'
     end
   end
@@ -38,7 +38,7 @@ task :develop => "develop:default"
 begin
   require 'rake/testtask'
   Rake::TestTask.new( :test ) do |t|
-    t.ruby_opts    = %w[ -w -rubygems ]
+    t.ruby_opts    = %w[ -w ]
     t.libs         = %w[ lib spec test ]
     t.pattern      = "{test,spec}/**/{test_*,*_spec}.rb"
   end
@@ -80,7 +80,7 @@ begin
     ENV['COVERAGE'] = 'true'
     Rake::Task[:test].execute
   end
-  CLOBBER << 'coverage' if File.directory?('coverage')
+  CLOBBER << 'coverage' if File.directory?( 'coverage' )
 rescue LoadError
   This.task_warning( 'simplecov' )
 end

data/tasks/extension.rake

@@ -23,9 +23,9 @@ begin
       ext.lib_dir   = File.join( 'lib', This.name )
       ext.gem_spec  = This.ruby_gemspec
 
-      ext.cross_compile  = true               # enable cross compilation (requires cross compile toolchain)
-      ext.cross_platform = 'i386-mingw32'     # forces the Windows platform instead of the default one
-                                              # configure options only for cross compile
+      ext.cross_compile  = true                         # enable cross compilation (requires cross compile toolchain)
+      ext.cross_platform = %w[x86-mingw32 x64-mingw32]  # forces the Windows platform instead of the default one
+                                                        # configure options only for cross compile
     end
   end
 

data/tasks/this.rb

@@ -194,7 +194,9 @@ class ThisProject
   end
 
   def license
-    "ISC"
+    license_file = project_path("LICENSE")
+    line = license_file.readlines.first
+    line.split(/\s+/).first
   end
 
   # Internal: The path to the gemspec file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hitimes
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.3.0
 platform: ruby
 authors:
 - Jeremy Hinegardner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2018-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -108,9 +108,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
-description: A fast, high resolution timer library for recording peformance metrics.
-  * (http://github.com/copiousfreetime/hitimes) * (http://github.com.org/copiousfreetime/hitimes)
-  * email jeremy at copiousfreetime dot org * `git clone url git://github.com/copiousfreetime/hitimes.git`
+description: "(https://travis-ci.org/copiousfreetime/hitimes.svg?branch=master)](https://travis-ci.org/copiousfreetime/hitimes)
+  A fast, high resolution timer library for recording peformance metrics. * (http://github.com/copiousfreetime/hitimes)
+  * (http://github.com.org/copiousfreetime/hitimes) * email jeremy at copiousfreetime
+  dot org * `git clone url git://github.com/copiousfreetime/hitimes.git`"
 email: jeremy@copiousfreetime.org
 executables: []
 extensions:
@@ -189,10 +190,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: A fast, high resolution timer library for recording peformance metrics.
+summary: "[![Build Status](https://travis-ci.org/copiousfreetime/hitimes.svg?branch=master)](https://travis-ci.org/copiousfreetime/hitimes)"
 test_files:
 - spec/hitimes_spec.rb
 - spec/interval_spec.rb