jeni 0.2.5 → 0.2.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTk0NDE2OWViOTU5YzYzOWMwZTc1YmVkZjZlZGE4M2E0NjNhMTRiZA==
+    YmIzMTg5YTE3M2NjN2Q4NzQzNzJjMWI1OGI1M2RlNmNiZmEyMjBkMw==
   data.tar.gz: !binary |-
-    ODEwOTA2YzcwNTg3ZGY3NDk1YjlhYmI3MTM4ZTlhZjQ5ZDdhZjYwZg==
-!binary "U0hBNTEy":
+    MmFhYjUwNjcwNjU4ODEwZWJlZDkyMjdkZTY1MzU1YzkwYzM0NjJhNA==
+SHA512:
   metadata.gz: !binary |-
-    MDM1ZjA1ZTUxMjg2OGJjYjY2ZGE5ZWQ3OWFkYTI4ZDA3MmQwYWUxOWVmNTJh
-    MWU3MmM3NzE1NzAxZjhhYjAzZWE4MmNkZThjMjE5ZDI1ZGZhNjI4N2Y3NTM1
-    ZDU4OTczYTdhY2Y0ZjNmOWY2YjNmZWZkODBjNTNjMGQ0ZWM0YmY=
+    OTgwNDMyNmE2ODNhYjU2NzQwZWJmMjAzYzg3MWQ0NTZlMzMxNDVkNTc0MDEw
+    YTdlZDMwYmM3ZTZhNWY4N2RhNGI2OTFkMGY2NmM2MTBjMTVlMzA3NTU2NzJm
+    NWIxNjU3ZTE2OTBjYWNhYjJhMTMxYzBlMGJhOGY0NjU2MGQ0Mjg=
   data.tar.gz: !binary |-
-    OGU3YzQ1MThhZWJjNTY0NDg0Y2QyOWI1MGVlMDEyNjg3ODE4MTdiYzQ4OGZm
-    YzhlYWM5NTYxZjgxYWE0YzNlZGI5Yjg2MjdjMDIyYmY1MmEwYWU1ZTQ5MDg5
-    YjJlZWU2OTdjYTYyMGFkZWQ0NzhkODRjOTU4ZTU3MTllYjBjMTc=
+    YTdjYzE1YThiYzNjYjcyNmJhNzQ0MmQ3MjNhZTAwNzI2M2I4ZDU0MTk4ZDhj
+    MTdiZDQzMmUwMjkwYTQ3MDkxZDc2MWNmMWUyNzEyYjllNmUyOGZmNDk3ZjAw
+    NWY0Zjg0ZWI5N2NiOWE5Yjc1NTJlOWI5YzcwMjhjNDE4YzdhYjI=

data/Bugs.rdoc

@@ -1,9 +1,17 @@
+# @markup rdoc
+# @title Bugs and Changes
+
 == Outstanding Bugs and Change Requests for Jeni
 
+[10-Oct-2014]
+
+  Convert to an instance eval approach rather than passing self to block!
+
 [20-Aug-2013]
 
   * Add a facility to check if a package has been installed and warn if it has not
-    or even exit on error
+    or even exit on error - alternatively just use File.exists? for an executable
+    and do it manually!
 
 [14-Sep-2012]
 

data/History.txt

@@ -4,6 +4,10 @@
 == History
 
 
+[jeni-0.2.6 13-Oct-2014]
+
+  General tidy up and sort out of the shebang method.
+
 [jeni-0.2.5 28-Aug-2013]
 
   make target_root accessible and ignore chown etc on pretend
@@ -32,4 +36,4 @@
 
 [jeni-0.2.0 04-Oct-2012]
 
-  Application forked from local 'jeni' due to Gam-space name clash.
+  Application forked from local 'jeni' due to Gem-space name clash.

data/README.md

@@ -1,7 +1,5 @@
 # JENI
 
-_(a.k.a Jumpin Ermin's Nifty Installer)_
-
 A simple alternative to rubigen and thor that can be used to create a post-install script 
 for a gem needing more than the standard file ops covered by rubygems. It can also be used 
 for straight directories instead of gems, if required.
@@ -18,7 +16,8 @@ To install,
 
     gem install jeni.
     
-It is a plain library with no binaries or the like.
+It is a plain library with no binaries or the like. To use it, you need to write a ruby
+script.
 
 ## Getting Started
 
@@ -98,7 +97,7 @@ If the target is a relative path then it will be relative to /usr/local unless y
 use the -u switch (with the optparse option) or the {Jeni::Options.usr} method to set
 it to '/usr'.
     
-Global options can also be set, as defined in #{Jeni::Options}. The same options can be set using {Jeni::Optparse#optparse} 
+Global options can also be set, as defined in {Jeni::Options}. The same options can be set using {Jeni::Optparse#optparse} 
 to automatically process command line options. Call it with ARGV instead of manually setting Jeni's options.
 
     Jeni::Installer.new_from_gem('jeni') do |jeni|
@@ -110,6 +109,48 @@ to automatically process command line options. Call it with ARGV instead of manu
       jeni.link('source/jeni.rb', File.join(target_dir, 'jeni_link.rb'))
     end.run!
 
+### Templates
+
+Jeni can do more than copy and link files. It can also generate files from a simple
+template. The templating engine is [HAML](http://haml.info/) but Jeni processes the
+template so that it is treated as plain text (otherwise HAML would try to convert)
+the file into HTML). 
+
+The main reason for having a template is to substitute local values into common files.
+For example, it can be used to create a config file for a gem that can point to files
+within the gem itself - useful for Sinatra with the app directory distributed in the gem.
+
+To set a local variable, simply add it as a hash pair to the template call:
+
+    jeni.template('source/template.haml.rb', 
+      File.join(target_dir, 'app.conf'), 
+      app_dir:File.join(jeni.gem_dir, 'app'))
+    
+Note that Jeni provides the gem directory through its own method {Jeni}Within the template, the hash key becomes a variable: 'app_dir' that can be interpolated
+in the usual manner:
+
+    # my config file
+    APP_ROOT=#{app_dir}    
+
+Finally, in case it might be useful, you can also have templates stored in standard
+places (~/.jeni/templates and /usr/local/share/templates) and Jeni will search for them when
+you use {Jeni::Installer#standard_template} (you only need to pass the basename).
+    
+### Wrappers, gems and rubies
+
+Jeni might not be necessary with Gems could install more files. With this in mind, Jeni tries to do
+the same sort of things that Gem does - e.g. create a wrapper script that calls the
+executable script in the gem. It even uses the same shebang approach because the sheband method
+has been lifted and adapted from rubygems. See the method description to understand
+all of the options: {Jeni::Actions#shebang}.
+
+However, if you are working on a platform that supports multiple rubies then I would
+recommend you leave selection of which ruby to the system. The only way this appears to
+be possible is with a custom shebang (add "custom_shebang: $env ruby" to your gemrc). This
+does not take any notice of options in the original shebang, but if they are universal you
+could always add them to you custom shebang? This is because the rubygems does pick up
+the original script's shebang but always tampers with the "ruby" bit. e.g. if it
+was /usr/bin/env ruby it changes the ruby to ruby19 (even /usr/bin/ruby19?).
 
 ## Code Walkthrough
 
@@ -130,9 +171,12 @@ Jeni has a variety of options that can be set and are separately defined in {Jen
 
 The code is available from [GitHub](https://github.com/osburn-sharp/jeni)
 
+Jeni stands for "Jumpin Ermin's Nifty Installer". Don't ask.
+
+
 ## Dependencies
 
-A ruby compiler - works with 1.8.7.
+A ruby compiler >= 1.8.7. Currently works on 1.9.3 and 2.0.0.
 
 Check the {file:Gemfile} for other dependencies.
 
@@ -169,7 +213,8 @@ To test users and groups there is the following, which will fail if not run as r
     
 ## Bugs
 
-Details of any unresolved bugs and change requests are in {file:Bugs.rdoc Bugs}. Issues can be logged and tracked through
+Details of any unresolved bugs and change requests are in {file:Bugs.rdoc Bugs}. 
+Issues can be logged and tracked through
 [GitHub](https://github.com/osburn-sharp/jeni/issues).
 
 ## Changelog

data/lib/jeni.rb

@@ -102,9 +102,9 @@ module Jeni
     #   be taken
     #
     def self.new_from_gem(gem_name)
-      gem_spec = Gem::Specification.find_by_name(gem_name)
-      installer = self.new(gem_spec.gem_dir, gem_name)
-      installer.set_gem(gem_spec.gem_dir)
+      @gem_spec = Gem::Specification.find_by_name(gem_name)
+      installer = self.new(@gem_spec.gem_dir, gem_name)
+      installer.set_gem(@gem_spec.gem_dir)
       if block_given? then
         yield(installer)
       end
@@ -184,7 +184,7 @@ module Jeni
     # 
     # @param [String] source is the gem-relative path to the file to copy
     # @param [String] target is a relative or absolute path to copy to
-    # @params [Hash] opts options for copying the file
+    # @param [Hash] opts options for copying the file
     # @option opts [String] :chown the name of the owner
     # @option opts [String] :chgrp the name of the group
     # @option opts [Octal] :chmod octal bit settings for chmod
@@ -243,7 +243,7 @@ module Jeni
     # check that a file exists
     #
     # @param [String] file to test, relative to the source (e.g. gem)
-    # @param [Hash] options
+    # @param [Hash] opts fpr file checking
     # @option opts [Symbol] :executable to check if it is also executable
     #
     def file_exists?(file, opts={})
@@ -255,7 +255,7 @@ module Jeni
     # create a new user
     #
     # @param [String] name of the new user to create
-    # @param [Hash] options for creating the user
+    # @param [Hash] opts for creating the user
     # @option opts [Integer] :uid user id instead of next available
     # @option opts [Integer] :gid group id instead of next available
     # @option opts [String] :home path to home directory for user, defaults to /home/$user
@@ -274,7 +274,7 @@ module Jeni
     # create a new group
     #
     # @param [String] name of the new group to create
-    # @param [Hash] options for creating the user
+    # @param [Hash] opts for creating the user
     # @option opts [Integer] :gid group id instead of next available
     # @option opts [Boolean] :skip set true to skip if user exists else fail
     #
@@ -317,7 +317,7 @@ module Jeni
     end
     
     # as for {Jeni::Installer#template} but searches for the source template from a list of predefined
-    # directories. These are ~/.jermine/templates and /usr/local/share/templates
+    # directories. These are ~/.jeni/templates and /usr/local/share/templates
     # 
     # @param (see #template)
     #
@@ -343,7 +343,7 @@ module Jeni
     #
     # @param [String] source is the relative path to the file to wrap
     # @param [String] target is an absolute path for the wrapper
-    # @params [Hash] opts options for wrapping the file
+    # @param [Hash] opts options for wrapping the file
     # @option opts [String] :chown the name of the owner
     #
     def wrapper(source, target, opts={})

data/lib/jeni/actions.rb

@@ -18,7 +18,9 @@
 
 module Jeni
   
-  # Implementation mixin containing methods for each action that Jeni carries out
+  # Implementation mixin containing methods for each action that Jeni carries out. These
+  # are internal methods - full details of the methods to use when writing
+  # a Jeni script are contained in the {file:README.md README} file and in {Jeni::Installer}.
   module Actions
     
     # Create a copy of the source file as the target file
@@ -163,7 +165,7 @@ module Jeni
     # return the path to the standard template, which can be found in 
     # the places search below.
     def get_template(source)
-      gsource = File.expand_path(File.join('.jermine', 'templates', source), '~')
+      gsource = File.expand_path(File.join('.jeni', 'templates', source), '~')
       unless File.exists?(gsource)
         gsource = File.join('usr', 'local', 'share', 'templates', source)
         unless File.exists(gsource)
@@ -279,60 +281,76 @@ TEXT
     # Generates a #! line for +bin_file_name+'s wrapper copying arguments if
     # necessary.
     #
+    # Adapted from rubygems.
+    #
     # If the :custom_shebang config is set, then it is used as a template
-    # for how to create the shebang used for to run a gem's executables.
+    # for how to create the shebang used for to run a gem's executables. Note
+    # you can set a custom_shebang in .gemrc e.g. "custom_shebang: $env ruby".
+    # It is set as a string and not a symbol.
     #
-    # The template supports 4 expansions:
+    # A custom shebang overides any other output.
     #
-    # $env the path to the unix env utility
-    # $ruby the path to the currently running ruby interpreter
-    # $exec the path to the gem's executable
-    # $name the name of the gem the executable is for
+    # if @env_shebang (see {Jeni::Options#env_shebang}) is set then the result will be the local env with the
+    # current ruby install name, e.g.: "/usr/bin/env ruby20". If there are
+    # options on the original script's shebang then the resultis slightly different.
+    # The shebang becomes a /bin/sh, which then exec's the ruby install name with
+    # the -x switch and itself as the file, finally inserting the original shebang
+    # (although the ruby has been replace with Gem.ruby). Love to know what all
+    # this is about!
     #
-    def shebang(source)
-      
-      env_paths = %w[/usr/bin/env /bin/env]
+    # Otherwise the value of Gem.ruby will be used with any of options
+    # added to the shebang on the original script.
+    #
+    # The template used for custom shebangs supports 4 expansions:
+    #
+    # * $env the path to the unix env utility
+    # * $ruby the path to the currently running ruby interpreter
+    # * $exec the path to the gem's executable
+    # * $name the name of the gem the executable is for
+    #
+    def shebang(path)
+      ruby_name = RbConfig::CONFIG['ruby_install_name'] if @env_shebang
       
-      ruby_name = Gem::ConfigMap[:ruby_install_name] #if @env_shebang
+      #path = File.join gem_dir, spec.bindir, bin_file_name
+      bin_file_name = File.basename(path)
+      first_line = File.open(path, "rb") {|file| file.gets}
       
-      first_line = File.open(source, "rb") {|file| file.gets}
-      env_path = nil
-  
       if /\A#!/ =~ first_line then
         # Preserve extra words on shebang line, like "-w". Thanks RPA.
         shebang = first_line.sub(/\A\#!.*?ruby\S*((\s+\S+)+)/, "#!#{Gem.ruby}")
         opts = $1
         shebang.strip! # Avoid nasty ^M issues.
       end
-  
+      
       if which = Gem.configuration[:custom_shebang]
+        # replace bin_file_name with "ruby" to avoid endless loops
+        which = which.gsub(/ #{bin_file_name}$/," #{RbConfig::CONFIG['ruby_install_name']}")
+        
         which = which.gsub(/\$(\w+)/) do
           case $1
           when "env"
-            env_path ||= env_paths.find do |e_path|
-                            File.executable? e_path
-                          end
+            @env_path ||= Gem::Installer::ENV_PATHS.find {|env_path| File.executable? env_path }
           when "ruby"
             "#{Gem.ruby}#{opts}"
           when "exec"
             bin_file_name
           when "name"
-            spec.name
+            @app_name
           end
         end
-  
+        
         return "#!#{which}"
-      end
-  
-      if not ruby_name then
-        "#!#{Gem.ruby}#{opts}"
+        
+      elsif not ruby_name then
+        return "#!#{Gem.ruby}#{opts}"
       elsif opts then
-        "#!/bin/sh\n'exec' #{ruby_name.dump} '-x' \"$0\" \"$@\"\n#{shebang}"
+        return "#!/bin/sh\n'exec' #{ruby_name.dump} '-x' \"$0\" \"$@\"\n#{shebang}"
       else
         # Create a plain shebang line.
-        env_path ||= env_paths.find {|e_path| File.executable? e_path }
-        "#!#{env_path} #{ruby_name}"
-      end
+        @env_path ||= Gem::Installer::ENV_PATHS.find {|env_path| File.executable? env_path }
+        return "#!#{@env_path} #{ruby_name}"
+      end      
+
     end
     
     # create a new user

data/lib/jeni/options.rb

@@ -73,6 +73,11 @@ module Jeni
       @target_root = path
     end
     
+    # set the shebang in wrappers to use env (e.g. /usr/bin/env)
+    def env_shebang(bool=true)
+      @env_shebang = bool
+    end
+    
   end
   
 end

data/lib/jeni/optparse.rb

@@ -77,6 +77,10 @@ module Jeni
         @target_root = t
       end
       
+      opts.on('-E', '--env-shebang', 'use the default env script in wrapper shebangs!') do
+        @env_shebang = true
+      end
+      
       
       if block_given? then
         yield(opts)

data/lib/jeni/version.rb

@@ -1,13 +1,13 @@
 # Created by Jevoom
 #
-# 28-Aug-2013
-#   make target_root accessible and ignore chown etc on pretend
+# 13-Oct-2014
+#   General tidy up and sort out of the shebang method.
 
 module Jeni
-  # version set to 0.2.5
-  Version = '0.2.5'
-  # date set to 28-Aug-2013
-  Version_Date = '28-Aug-2013'
-  #ident string set to: jeni-0.2.5 28-Aug-2013
-  Ident = 'jeni-0.2.5 28-Aug-2013'
+  # version set to 0.2.6
+  Version = '0.2.6'
+  # date set to 13-Oct-2014
+  Version_Date = '13-Oct-2014'
+  #ident string set to: jeni-0.2.6 13-Oct-2014
+  Ident = 'jeni-0.2.6 13-Oct-2014'
 end

data/spec/jeni_shebang_spec.rb

@@ -0,0 +1,52 @@
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2014 Robert Sharp
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file copyright.txt. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+# 
+#
+
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'jeni/errors'
+require 'jeni/actions'
+
+proot = File.dirname(File.dirname(__FILE__))
+conf_file = File.expand_path(File.dirname(__FILE__) + '/../test/shebang.rb')
+
+# mimic the class without actually having to set one up!
+# have to create the odd instance variable along the way.
+include Jeni::Actions
+
+describe Jeni do
+
+  
+  it "should output a plain specific ruby with and without env" do
+    #@gem_spec = Gem::Specification.find_by_name('jerbil')
+    Gem.configuration[:custom_shebang] = nil
+    expect(shebang(conf_file)).to match(/\A#!\/usr\/bin\/ruby[0-9]{2,2}\z/)
+    @env_shebang = true
+    expect(shebang(File.join(proot, 'test', 'noshebang.rb'))).to match(/\A#!\/usr\/bin\/env ruby[0-9]{2,2}\z/)
+  end
+  
+  it "should output a custom shebang" do
+    Gem.configuration[:custom_shebang] = "$env ruby"
+    expect(shebang(conf_file)).to match(/\A#!\/usr\/bin\/env ruby\z/)
+  end
+  
+  it "should output a custom shebang with all variables defined" do
+    @app_name = 'jerbil'
+    Gem.configuration[:custom_shebang] = "$env $ruby $exec $name"
+    expect(shebang(conf_file)).to match(/\A#!\/usr\/bin\/env \/usr\/bin\/ruby[0-9]{2,2} shebang.rb jerbil\z/)
+  end
+  
+  it "should output a shebang with options" do
+    @env_shebang = false
+    expect(shebang(File.join(proot, 'test', 'optshebang.rb'))).to match(/\A#!\/usr\/bin\/env ruby[0-9]{2,2} \-x\z/)
+  end
+
+end

data/spec/spec_helper.rb

@@ -17,10 +17,10 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'jeni'
 require 'rspec'
-require 'rspec/autorun'
+
 
 RSpec.configure do |config|
-  config.color_enabled = true
+  config.color = true
   config.formatter = :doc
 end
 

data/test/noshebang.rb

@@ -0,0 +1 @@
+puts "This is ruby"

data/test/optshebang.rb

@@ -0,0 +1 @@
+#!/usr/bin/env ruby -x

data/test/shebang.rb

@@ -0,0 +1 @@
+#!/usr/bin/env ruby

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jeni
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Dr Robert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-28 00:00:00.000000000 Z
+date: 2014-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: !binary |-
@@ -70,48 +70,52 @@ extra_rdoc_files:
 - Gemfile
 - README.md
 files:
-- History.txt
 - Bugs.rdoc
+- Gemfile
+- History.txt
 - Intro.txt
 - LICENCE.rdoc
-- Gemfile
 - README.md
+- lib/jeni.rb
+- lib/jeni/actions.rb
 - lib/jeni/errors.rb
-- lib/jeni/version.rb
-- lib/jeni/utils.rb
+- lib/jeni/io.rb
 - lib/jeni/options.rb
 - lib/jeni/optparse.rb
-- lib/jeni/io.rb
-- lib/jeni/actions.rb
-- lib/jeni.rb
-- spec/spec_helper.rb
+- lib/jeni/utils.rb
+- lib/jeni/version.rb
+- spec/jeni_shebang_spec.rb
 - spec/jeni_spec.rb
 - spec/jeni_utils_spec.rb
-- test/examples/source/shebang.rb
-- test/examples/source/executable
-- test/examples/source/template.haml.rb
+- spec/spec_helper.rb
 - test/examples/source/coati.haml.conf
-- test/examples/source/subfiles/subfile_1.rb
-- test/examples/source/jeni.rb
+- test/examples/source/executable
 - test/examples/source/jeni-diff.rb
-- test/examples/test1.rb
-- test/examples/test_args
-- test/examples/test2.rb
-- test/examples/test_users
-- test/examples/target/jenny.rb
+- test/examples/source/jeni.rb
+- test/examples/source/shebang.rb
+- test/examples/source/subfiles/subfile_1.rb
+- test/examples/source/template.haml.rb
+- test/examples/target/archive/coati.haml.conf
+- test/examples/target/archive/executable
 - test/examples/target/archive/jenny-diff.rb
 - test/examples/target/archive/jenny.rb
 - test/examples/target/archive/shebang.rb
-- test/examples/target/archive/executable
-- test/examples/target/archive/template.haml.rb
-- test/examples/target/archive/coati.haml.conf
 - test/examples/target/archive/subfiles/subfile_1.rb
-- test/examples/target/jenny_link.rb
-- test/examples/target/test.rb
+- test/examples/target/archive/template.haml.rb
 - test/examples/target/jeni.rb
 - test/examples/target/jeni_template.rb
+- test/examples/target/jenny.rb
+- test/examples/target/jenny_link.rb
 - test/examples/target/shebang.rb
+- test/examples/target/test.rb
 - test/examples/target2/subfiles/subfile_1.rb
+- test/examples/test1.rb
+- test/examples/test2.rb
+- test/examples/test_args
+- test/examples/test_users
+- test/noshebang.rb
+- test/optshebang.rb
+- test/shebang.rb
 homepage: ''
 licenses:
 - Open Software Licence v3.0
@@ -133,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: A little post-install helper for Gems to install things Gems can't reach,