juwelier 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 119428dd902c5e6abedfa4125a7b18f003140b0e
-  data.tar.gz: f5997ea019b8d5edaecb5c0d6cec2ff80b503e7d
+  metadata.gz: 50da599b91b3c3ee8a0b551339bc03d4ee2911d0
+  data.tar.gz: f05218665fa821263f12c87565d7ebd0973e0f18
 SHA512:
-  metadata.gz: 2f3848de494daf486dd39950b9458d9af942570605d3ac945b92eba825d5726f09b82d057f850c167260da337d9566e27aa18eda425f1267e34dd5256b83aa3e
-  data.tar.gz: 4fea5d9f109be06af0d0273af258ad7b782a5b1409b4209e3e47436d1dd4a9bc9b5913d6512af62fec5115a7ed945d7d98dfdf14069e30221490524bc184a960
+  metadata.gz: ff469e8865a3fd3084b0dd6a6abb0a9135a9bd784c177039bc2db744b0693ff661108aab76d6696aeb506ea6c9c753f06b0303fea3a184bdb673b20294e909db
+  data.tar.gz: 35feec9cb55040de84973b9ccdc7b258ba2d7bf27047fbe28d433df4559158ef67bb4ebc6202acb5db2bad899380a1f92a5a2b2176975f96b912af01bee8d800

data/.semver

@@ -1,5 +1,5 @@
 ---
 :major: 2
-:minor: 3
-:patch: 6
+:minor: 4
+:patch: 1
 :special: ''

data/Gemfile

@@ -10,6 +10,7 @@ gem "rdoc"
 gem "builder"
 gem "semver2"
 gem "psych", "~> 2.2"
+gem "kamelcase", "~> 0"
 
 group :development do
   gem "yard", ">= 0.8.5"

data/README.org

@@ -366,9 +366,57 @@ friendship doesn't interfere with typical Rake operations.
 The Juwelier Rake means you can define your own namespaces, tasks, or
 use third party Rake libraries without cause for concern.
 
+** New Features
+*** Rusty Gems Support (highly experimental)
+    Beginning with version 2.4.0, we now have integration
+    with Rust, so you are able to write Rust-enabled gems.
+    Your users will have to have Rust installed on their
+    systems, but this is easy to do.
+
+    This interface currently uses FFI, and I don't have all
+    the bugs worked out, so use at your own risk (for now).
+**** Example
+     First, create your Rusty Gem:
+     #+begin_src bash
+     juwelier --semver --rusty foo
+     #+end_src
+
+     Next, cd into the foo directory and run bundle
+     and attempt to run the test:
+     #+begin_src bash
+     bundle
+     ruby lib/foo.rb
+     #+end_src
+
+     The test attempt should fail, since we have not built
+     the Rust extension yet. Do so by doing the following:
+     #+begin_src
+     cd rust
+     make
+     cd ..
+     #+end_src
+
+     And then attempt to run the test again:
+     #+begin_src bash
+     ruby lib/foo.rb
+     #+end_src
+
+     That should work. Now install the gem locally with:
+     #+begin_src bash
+     rake gemspec
+     rake install
+     #+end_src
+
+     And that should install your foo gem cleanly.
+
+     As of now, this feature is extremely experimental, but
+     if you should be able to use this as a nice scafford
+     to do your own Rusty Gems. I will improve this later.
+
 ** Release Notes
    | Version |       Date | Notes                                                                                                       |
    |---------+------------+-------------------------------------------------------------------------------------------------------------|
+   |   2.4.0 | 2017-05-09 | Support for Rusty Gems (highly experimental)                                                                |
    |   2.3.5 | 2017-02-10 | Revving Semver to be Semver2                                                                                |
    |   2.2.3 | 2016-11-21 | Psych bug fixed                                                                                             |
    |   2.2.2 | 2016-11-19 | Added support for pry -- includes pry, pry-byebug, pry-doc, pry-remote, pry-rescue. and pry-stack_explorer. |

data/juwelier.gemspec

@@ -2,23 +2,22 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: juwelier 2.4.0 ruby lib
+# stub: juwelier 2.4.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "juwelier".freeze
-  s.version = "2.4.0"
+  s.version = "2.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Fred Mitchell".freeze, "Josh Nichols".freeze, "Yusuke Murata".freeze]
-  s.date = "2017-05-09"
+  s.date = "2017-05-10"
   s.description = "Simple and opinionated helper for creating Rubygem projects on GitHub".freeze
   s.email = ["fred.mitchell@gmx.de".freeze, "fred.mitchell@gmx.com".freeze, "info@muratayusuke.com".freeze]
   s.executables = ["juwelier".freeze]
   s.extra_rdoc_files = [
     "ChangeLog.markdown",
     "LICENSE.txt",
-    "README.markdown",
     "README.org"
   ]
   s.files = [
@@ -30,7 +29,6 @@ Gem::Specification.new do |s|
     "ChangeLog.markdown",
     "Gemfile",
     "LICENSE.txt",
-    "README.markdown",
     "README.org",
     "Rakefile",
     "bin/juwelier",
@@ -108,6 +106,7 @@ Gem::Specification.new do |s|
     "lib/juwelier/templates/features/default.feature",
     "lib/juwelier/templates/features/support/env.rb",
     "lib/juwelier/templates/juwelier_tasks.erb",
+    "lib/juwelier/templates/lib/rustygem.rb",
     "lib/juwelier/templates/micronaut/flunking.rb",
     "lib/juwelier/templates/micronaut/helper.rb",
     "lib/juwelier/templates/minitest/flunking.rb",
@@ -118,6 +117,11 @@ Gem::Specification.new do |s|
     "lib/juwelier/templates/rspec/.rspec",
     "lib/juwelier/templates/rspec/flunking.rb",
     "lib/juwelier/templates/rspec/helper.rb",
+    "lib/juwelier/templates/rust/Cargo.toml",
+    "lib/juwelier/templates/rust/Makefile",
+    "lib/juwelier/templates/rust/extconf.rb",
+    "lib/juwelier/templates/rust/src/lib.rs",
+    "lib/juwelier/templates/rusty_setup.erb",
     "lib/juwelier/templates/semver_tasks.erb",
     "lib/juwelier/templates/shindo/flunking.rb",
     "lib/juwelier/templates/shindo/helper.rb",
@@ -130,6 +134,7 @@ Gem::Specification.new do |s|
     "lib/juwelier/templates/testunit/helper.rb",
     "lib/juwelier/version.rb",
     "lib/juwelier/version_helper.rb",
+    "oldREADME.md",
     "test/fixtures/bar/VERSION.yml",
     "test/fixtures/bar/bin/foo_the_ultimate_bin",
     "test/fixtures/bar/hey_include_me_in_gemspec",

data/lib/juwelier/generator.rb

@@ -3,7 +3,7 @@ require 'git'
 require 'github_api'
 require 'highline/import'
 require 'erb'
-
+require 'kamelcase'
 require 'net/http'
 require 'uri'
 
@@ -56,7 +56,8 @@ class Juwelier
                   :should_setup_rubyforge, :should_use_reek, :should_use_roodi,
                   :development_dependencies, :production_dependencies,
                   :options, :require_ruby_version, :should_create_bin,
-                  :git_remote, :use_readme_format, :should_use_pry
+                  :git_remote, :use_readme_format, :should_use_pry,
+                  :should_be_rusty
 
     def initialize(options = {})
       self.options = options
@@ -106,6 +107,7 @@ class Juwelier
       self.should_use_semver      = options[:use_semver]
       self.require_ruby_version   = options[:use_required_version]
       self.should_create_bin      = options[:create_bin]
+      self.should_be_rusty        = options[:be_rusty]
       self.should_use_pry         = options[:use_pry]
       self.use_readme_format      = options[:readme_format]
 
@@ -127,7 +129,8 @@ class Juwelier
         ["pry-stack_explorer", "~> 0"] if should_use_pry
                                          
       production_dependencies << ["semver2", "~> 3"] if should_use_semver
-
+      production_dependencies << ['ffi', '~> 1'] if should_be_rusty
+      
       self.user_name       = options[:user_name]
       self.user_email      = options[:user_email]
       self.homepage        = options[:homepage]
@@ -151,16 +154,15 @@ class Juwelier
     end
 
     def constant_name
-      self.project_name.split(/[-_]/).collect{|each| each.capitalize }.join
-    end
-
-    def lib_filename
-      "#{project_name}.rb"
+      self.project_name.camel
     end
 
-    def bin_filename
-      "#{should_create_bin}"
+    def extension_name
+      "lib#{self.project_name.snake}.so"
     end
+    
+    def lib_filename ; "#{project_name}.rb" ; end
+    def bin_filename ; "#{should_create_bin}" ; end
 
     def require_name
       self.project_name
@@ -170,13 +172,10 @@ class Juwelier
       self.project_name.gsub('-', '_')
     end
 
-    def lib_dir
-      'lib'
-    end
-
-    def bin_dir
-      'bin'
-    end
+    def lib_dir      ; 'lib'      ; end
+    def bin_dir      ; 'bin'      ; end    
+    def rust_dir     ; 'rust'     ; end
+    def rust_src_dir ; rust_dir + '/src' ; end
 
     def feature_filename
       "#{project_name}.feature"
@@ -207,7 +206,6 @@ class Juwelier
         raise FileInTheWay, "The directory #{target_dir} already exists, aborting. Maybe move it out of the way before continuing?"
       end
 
-
       output_template_in_target '.gitignore'
       output_template_in_target 'Rakefile'
       output_template_in_target 'Gemfile' if should_use_bundler
@@ -216,7 +214,12 @@ class Juwelier
       output_template_in_target '.document'
 
       mkdir_in_target           lib_dir
-      touch_in_target           File.join(lib_dir, lib_filename)
+      unless should_be_rusty
+        touch_in_target           File.join(lib_dir, lib_filename)
+      else
+        output_template_in_target File.join(lib_dir, 'rustygem.rb'),
+                                  File.join(lib_dir, lib_filename)
+      end
 
       if should_use_semver
         output_template_in_target '.semver'
@@ -233,10 +236,18 @@ class Juwelier
                                   File.join(test_dir, test_filename)
       end
 
+      if should_be_rusty
+        mkdir_in_target rust_dir
+        output_template_in_target File.join(rust_dir, 'Cargo.toml')
+        output_template_in_target File.join(rust_dir, 'extconf.rb')
+        output_template_in_target File.join(rust_dir, 'Makefile')
+        mkdir_in_target rust_src_dir
+        output_template_in_target File.join(rust_src_dir, 'lib.rs')
+      end
+      
       if testing_framework == :rspec
         output_template_in_target File.join(testing_framework.to_s, '.rspec'),
                                   '.rspec'
-
       end
 
       if should_use_cucumber

data/lib/juwelier/generator/options.rb

@@ -81,6 +81,10 @@ class Juwelier
             self[:create_bin] = v
           end
 
+          o.on('--[no-]rusty', 'create a gem using Rust') do |v|
+            self[:be_rusty] = v
+          end
+
           o.on('--cucumber', 'generate cucumber stories in addition to the other tests') do
             self[:use_cucumber] = true
           end

data/lib/juwelier/tasks.rb

@@ -27,7 +27,7 @@ class Juwelier
   #     gem.email = "fred.mitchell@gmx.com"
   #     gem.homepage = "http://github.com/flajann2/juwelier"
   #     gem.description = "Simple and opinionated helper for creating RubyGem projects on GitHub"
-  #     gem.authors = ["Josh Nichols"]
+  #     gem.authors = ["Fred Mitchell"]
   #   end
   #
   # The block variable gem is actually a Gem::Specification, so you can

data/lib/juwelier/templates/Rakefile

@@ -4,7 +4,5 @@ require 'rubygems'
 <%= render_template 'bundler_setup.erb' %>
 require 'rake'
 <%= render_template 'semver_tasks.erb' %>
-
 <%= render_template 'juwelier_tasks.erb' %>
-
 <%= render_template 'other_tasks.erb' %>

data/lib/juwelier/templates/juwelier_tasks.erb

@@ -15,6 +15,11 @@ Juwelier::Tasks.new do |gem|
   gem.required_ruby_version = '>= <%= require_ruby_version %>'
 <% end %>
 
+<% if should_be_rusty %>
+  # Rusty Gem
+  gem.extensions = Dir['rust/extconf.rb']
+<% end %>
+
 <% if should_setup_rubyforge %>
   gem.rubyforge_project = "<%= project_name %>"
 <% end %>

data/lib/juwelier/templates/lib/rustygem.rb

@@ -0,0 +1,18 @@
+require 'ffi'
+
+module <%= constant_name %>
+  extend FFI::Library
+  ffi_lib 'rust/target/release/<%= extension_name %>'
+  
+  attach_function :simple_test, [ :string, :int ], :int
+  attach_function :hello_world, [ :string, :int ], :int
+end
+
+if $0 == __FILE__
+  json = <<-JSON
+  {"hello":"Hello", "world":"World" }
+JSON
+ 
+  puts <%= constant_name %>::simple_test "Hi there!", 10
+  puts <%= constant_name %>::hello_world json, 3
+end

data/lib/juwelier/templates/rust/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "<%= project_name %>"
+version = "0.1.0"
+authors = ["<%= user_name %> <%= user_email %>"]
+
+[dependencies]
+serde = "1.0.2"
+serde_json = "1.0.1"
+serde_derive = "1.0.2"
+libc = "0.2.22"
+
+[lib]
+name = "<%= project_name %>"
+crate-type = ["dylib"]

data/lib/juwelier/templates/rust/Makefile

@@ -0,0 +1,11 @@
+# rust/Makefile:
+all:
+	cargo build --release
+
+clean:
+	rm -rf target
+
+install: ;
+
+# gemspec
+spec.extensions = Dir['rust/extconf.rb']

data/lib/juwelier/templates/rust/extconf.rb

@@ -0,0 +1,2 @@
+# rust/extconf.rb
+raise 'You have to install Rust with Cargo (https://www.rust-lang.org/)' if !system('cargo --version') || !system('rustc --version')

data/lib/juwelier/templates/rust/src/lib.rs

@@ -0,0 +1,55 @@
+
+#[cfg(test)]
+
+extern crate serde;
+extern crate libc;
+extern crate serde_json;
+
+#[macro_use]
+extern crate serde_derive;
+
+use serde_json::from_str;
+use serde_json::Error;
+use std::result::Result;
+
+/// HelloWorld as a target from the JSON from Ruby
+#[derive(Debug)]
+#[derive(Serialize, Deserialize)]
+pub struct HelloWorld {
+    hello: String,
+    world: String
+}
+
+/// Super-simple test
+#[no_mangle]
+pub extern "C" fn simple_test(s: &str, i: u32) ->  u32 {
+    println!("got a string of {}", s);
+    println!("got an integer of {}", i);
+    i + 10
+}
+
+/// This is an example of passing complex objects
+/// from Ruby to Rust with strong type checking as JSON
+#[no_mangle]
+pub extern "C" fn hello_world(json: &str, count: u32) ->  Result<u32, Error> {
+    let hw: HelloWorld = from_str(json)?;
+
+    println!("hello_world called with {:?} to be printed {} times.", hw, count);
+
+    // We simply want to show how to pass primitives as well
+    for i in 0..count {
+        println!("{}: hw: {:?}", i, hw);
+    }
+
+    // return one less than the count given
+    Ok(count - 1)
+}
+
+/// Here we must free strings from Rust when we are done
+/// with them.
+#[no_mangle]
+pub extern fn rust_free(c_ptr: *mut libc::c_void) {
+    unsafe {
+        libc::free(c_ptr);
+    }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: juwelier
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Fred Mitchell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-09 00:00:00.000000000 Z
+date: 2017-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -233,7 +233,6 @@ extensions: []
 extra_rdoc_files:
 - ChangeLog.markdown
 - LICENSE.txt
-- README.markdown
 - README.org
 files:
 - ".coveralls.yml"
@@ -244,7 +243,6 @@ files:
 - ChangeLog.markdown
 - Gemfile
 - LICENSE.txt
-- README.markdown
 - README.org
 - Rakefile
 - bin/juwelier
@@ -322,6 +320,7 @@ files:
 - lib/juwelier/templates/features/default.feature
 - lib/juwelier/templates/features/support/env.rb
 - lib/juwelier/templates/juwelier_tasks.erb
+- lib/juwelier/templates/lib/rustygem.rb
 - lib/juwelier/templates/micronaut/flunking.rb
 - lib/juwelier/templates/micronaut/helper.rb
 - lib/juwelier/templates/minitest/flunking.rb
@@ -332,6 +331,11 @@ files:
 - lib/juwelier/templates/rspec/.rspec
 - lib/juwelier/templates/rspec/flunking.rb
 - lib/juwelier/templates/rspec/helper.rb
+- lib/juwelier/templates/rust/Cargo.toml
+- lib/juwelier/templates/rust/Makefile
+- lib/juwelier/templates/rust/extconf.rb
+- lib/juwelier/templates/rust/src/lib.rs
+- lib/juwelier/templates/rusty_setup.erb
 - lib/juwelier/templates/semver_tasks.erb
 - lib/juwelier/templates/shindo/flunking.rb
 - lib/juwelier/templates/shindo/helper.rb
@@ -344,6 +348,7 @@ files:
 - lib/juwelier/templates/testunit/helper.rb
 - lib/juwelier/version.rb
 - lib/juwelier/version_helper.rb
+- oldREADME.md
 - test/fixtures/bar/VERSION.yml
 - test/fixtures/bar/bin/foo_the_ultimate_bin
 - test/fixtures/bar/hey_include_me_in_gemspec