czmq-ffi-gen 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55c3b94ea8b765c6c5b0adfd94871605ca9c5c9d
-  data.tar.gz: f2f9382d703edf71e021b0284d53665365bac1e7
+  metadata.gz: a13b3283c23574dcb273bb0cceb1e1dea053a3ae
+  data.tar.gz: 5f53828a3de118cbccdaad5c48158f919b1a7767
 SHA512:
-  metadata.gz: e7532af2abb52747c21ae55937fe21cca3db967b887c4d300d9cdf5e87bf260d485ea41c2ffac8c03dd98760e62d70b9c15c886fc6d285eadb4c45a979666401
-  data.tar.gz: c2f8df1ffbd7c6ed4edda6116e1f03597f98a71411a3f069e8bec57b3970e30dc4064f172bd77626c61931dbb38de0169b1c0cc46e42b4c9433e1beb17f00253
+  metadata.gz: 1722efb1d34de52a034f0395b6dfefca180e6106d91c9cb7d498500a20141f3fae8e3e4793690a751acc68da2a354be976202cf2b0699ac37e2a0d27843ce9a7
+  data.tar.gz: 988aab153814bf5d9cdf9c511eee3bb134456df30f8951778c66933ff5c20ba721d28bddbf3be93a9efe28d186b5f6d7c4b9ef230d14400bfdec1efc8e86ac10

data/AUTHORS

@@ -0,0 +1 @@
+Patrik Wenger <paddor@gmail.com>

data/CHANGES.md

@@ -0,0 +1,7 @@
+0.1.1 (12/09/2015)
+-----
+* include some auxiliary files like CHANGES.md, LICENSE, and README.md into gem
+
+0.1.0 (12/09/2015)
+-----
+* Initial release

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2015, Patrik Wenger
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/README.md

@@ -0,0 +1,97 @@
+[![Build Status on Travis CI](https://travis-ci.org/paddor/czmq-ffi-gen.svg?branch=master)](https://travis-ci.org/paddor/czmq-ffi-gen?branch=master)
+[![Dependency Status](https://gemnasium.com/paddor/czmq-ffi-gen.svg)](https://gemnasium.com/paddor/czmq-ffi-gen)
+
+# Generated CZMQ::FFI
+
+This repository is used to package and release the Ruby gem _czmq-ffi-gen_, the
+low-level Ruby FFI binding for [CZMQ](https://github.com/zeromq/czmq).  The gem
+_czmq-ffi-gen_ can be used as a base for a higher-level CZMQ binding like
+[CZTop](https://github.com/paddor/cztop). But of course you can use it for
+anything you want. :-)
+
+## Caveats
+
+### Not Ruby-like
+This is generated code. It is generated from the API models in CZMQ using
+[zproject](https://github.com/zeromq/zproject). It doesn't feel like Ruby. It's
+not intended to be used directly. Instead, use
+[CZTop](https://github.com/paddor/cztop), or write your own wrapper for this
+library.
+
+### Generated code isn't actually in this repository
+The actual generated code lies in CZMQ, which is Git submodule of this
+repository, registered under `vendor/czmq`.
+
+So if you're not happy with any of the generated code, go have a closer look at
+CZMQ or zproject, which is used by CZMQ to generate the low-level binding.
+
+### API Documentation
+For that same reason, API documentation of unreleased code (directly off this
+repository), like
+[rubydoc.info/github/paddor/czmq-ffi-gen](http://www.rubydoc.info/github/paddor/czmq-ffi-gen)
+**does NOT include any of the generated code**. _Rubydoc.info_ doesn't check
+out Git submodules as part of its documentation procedure. However, API
+documentation of the **released gem should work** just fine, as the gem release
+process will include all required source files directly within the gem.
+
+**Check out**
+[http://www.rubydoc.info/gems/czmq-ffi-gen](http://www.rubydoc.info/gems/czmq-ffi-gen)
+for the API documentation.
+
+## Supported Rubies
+
+Tested with these:
+
+* Ruby 2.2.3
+* JRuby HEAD (>= 9.0.0.0)
+* Rubinius
+
+
+### Known NOT to work
+
+* JRuby 1.7.x
+  * doesn't work because of the use of the double splat operator (`**opts`)
+
+## Installation
+
+This gem requires the presence of the CZMQ library, which in turn requires the
+ZMQ library. For **security mechanisms** like CURVE, you'll need
+[libsodium](https://github.com/jedisct1/libsodium).
+
+On OSX using homebrew, run:
+
+    $ brew install libsodium czmq
+
+If you're running Linux, go check [this page](http://zeromq.org/distro:_start)
+to get more help. Make sure to install CZMQ, not only ZMQ.
+
+To then use this gem, add this line to your application's Gemfile:
+
+```ruby
+gem 'czmq-ffi-gen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install czmq-ffi-gen
+
+## Usage
+
+Check out [CZTop](https://github.com/paddor/cztop) or the API documentation to
+see how this project can be used. :-)
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [ISC
+License](http://opensource.org/licenses/ISC).  See the
+[LICENSE](https://github.com/paddor/cztop/blob/master/LICENSE) file.

data/lib/czmq-ffi-gen/gem_version.rb

@@ -1,5 +1,5 @@
 module CZMQ
   module FFI
-    GEM_VERSION = "0.1.0"
+    GEM_VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: czmq-ffi-gen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Patrik Wenger
@@ -87,6 +87,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- AUTHORS
+- CHANGES.md
+- Gemfile
+- LICENSE
+- README.md
 - lib/czmq-ffi-gen.rb
 - lib/czmq-ffi-gen/czmq/ffi.rb
 - lib/czmq-ffi-gen/czmq/ffi/version.rb