ruby3mf 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 737fe004ae04714fe3a70c43ec4ccfa82b0472fb
-  data.tar.gz: 887d66d7fc0779bd0094ebd3c7a09fbfd3c1bc16
+  metadata.gz: bfa77bf22c653104e5afdffb0eb593491b2b8fb5
+  data.tar.gz: 06a01c80a9fc143e4fee068804b66f224c8b50c2
 SHA512:
-  metadata.gz: 1cd5a582a8d7450f6f8b9cd8076a674e520c0782061871058371c998b4e06e77bb8e777cc27c0334db083d2f12ce0fefe9833571781ef0aae856046703869694
-  data.tar.gz: 1f0a3bf6e58cdbda7b84506032c1ba08c5ad69fc8edb145f84c06573341c4cb81345add496546cef26e42f215de8deeddf0eae6f9bab9046e42c49ce82c25292
+  metadata.gz: 0e2a9b6c647f2e0f7f50ca5fd67ee846ee69720a8b784fa7efa51c01a167f989eb55364f663d5fb95fd19dae5fdaa41a79768997e93438225ee14686dedecf0a
+  data.tar.gz: 66a8434cd4017727199c0f6017f6d55baaafb6e91ce938ddb4d8df8afcb387f24809f7ac6f853f795b976648b665c5a4cb6bc1b19b80c615b36fb247f716c64d

data/README.md

@@ -2,9 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/ruby3mf.svg)](http://badge.fury.io/rb/ruby3mf)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruby3mf`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The ruby3mf gem provides an API for parsing and validating 3MF files.  It includes a logging mechanism that enables developers to programmatically check a 3MF file for warnings or errors and respond in whatever way is appropriate for their application.  Ruby3mf checks everything in the 3MF core specification, from making sure that the 3MF package contains all content in the right format needed to print the file, to verifying that the geometry represents a manifold solid without holes or incorrectly oriented triangles. 
 
 ## Installation
 
@@ -24,13 +22,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+Log3mf.reset_log
+Log3mf.context <filename> do |l|
+    Document.read(<file>)
+end
+ 
+if Log3mf.count_entries(:error, :fatal_error) > 0
+    entries = Log3mf.entries
+end
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/ruby3mf/version.rb

@@ -1,3 +1,3 @@
 module Ruby3mf
-  VERSION = "0.2.8"
+  VERSION = "0.2.9"
 end

data/ruby3mf.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Mike Whitmarsh, Jeff Porter, and William Hertling"]
   spec.email         = ["mwhit@hp.com", "jeff.porter@hp.com", "william.hertling@hp.com"]
 
-  spec.summary       = %q{Read, write and validate 3MF files with Ruby}
-  spec.description   = %q{Read, write and validate 3MF files with Ruby easily.}
+  spec.summary       = %q{Parse and validate 3MF files with Ruby}
+  spec.description   = %q{Parse and validate 3MF files with Ruby easily.}
   spec.homepage      = "https://github.com/IPGPTP/ruby3mf"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby3mf
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Mike Whitmarsh, Jeff Porter, and William Hertling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2017-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
-description: Read, write and validate 3MF files with Ruby easily.
+description: Parse and validate 3MF files with Ruby easily.
 email:
 - mwhit@hp.com
 - jeff.porter@hp.com
@@ -203,5 +203,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Read, write and validate 3MF files with Ruby
+summary: Parse and validate 3MF files with Ruby
 test_files: []