jeni 0.2.0 → 0.2.1

data/History.txt

@@ -4,6 +4,11 @@
 == History
 
 
+[jeni-0.2.1 26-Oct-2012]
+
+  Added relative paths to targets that can take /usr/ or /usr/local as their root.
+  Got rspec tests to work
+
 [jeni-0.2.0 04-Oct-2012]
 
   Application forked from local 'jeni' due to Gam-space name clash.

data/README.md

@@ -8,7 +8,7 @@ for straight directories instead of gems, if required.
 
 **GitHub:** [https://github.com/osburn-sharp/jeni](https://github.com/osburn-sharp/jeni)
 
-**RubyDoc:** [http://rdoc.info/github/osburn-sharp/jeni/frames](http://rdoc.info/github/osburn-sharp/jeni/frames)
+**RubyDoc:** [http://rubydoc.info/github/osburn-sharp/jeni/frames](http://rubydoc.info/github/osburn-sharp/jeni/frames)
 
 **RubyGems:** [https://rubygems.org/gems/jeni](https://rubygems.org/gems/jeni)
 
@@ -18,7 +18,7 @@ To install,
 
     gem install jeni.
     
-It is a plain library with no binaries or the like. Documentation is available from [RDoc]()
+It is a plain library with no binaries or the like.
 
 ## Getting Started
 
@@ -36,8 +36,8 @@ This is a simple example:
       jeni.pretend(opt[:pretend]) 
       # copy a file
       jeni.file('source.rb', '/etc/target.rb')
-      # create a wrapper
-      jeni.wrapper('sbin/jenerate.rb', '/usr/sbin/jenerate')
+      # create a wrapper in /usr/local
+      jeni.wrapper('sbin/jenerate.rb', 'sbin/jenerate')
     end.run!
     # and run jeni
 
@@ -93,6 +93,10 @@ If the source is a relative path then it will be looked for relative to the Inst
 So, for a gem {Jeni::Installer.new_from_gem} it will be relative to the gem's directory and for a directory 
 {Jeni::Installer.new} it will be relative to that. If the source is an absolute path (starts with '/')
 then it will be used as given.
+
+If the target is a relative path then it will be relative to /usr/local unless you
+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} 
 to automatically process command line options. Call it with ARGV instead of manually setting Jeni's options.
@@ -134,7 +138,8 @@ Check the {file:Gemfile} for other dependencies.
 
 ### Documentation
 
-Documentation is best viewed using Yard. Documentation is available from [Rubydoc](http://rdoc.info/github/osburn-sharp/jeni/frames)
+Documentation is best viewed using Yard. Documentation is available from 
+[Rubydoc](http://rubydoc.info/github/osburn-sharp/jeni/frames)
 
 ## Testing/Modifying
 

data/lib/jeni.rb

@@ -65,6 +65,7 @@ module Jeni
       #@gem_spec = Gem::Specification.find_by_name(@gem_name)
       #@gem_dir = @gem_spec.gem_dir
       @source_root = source_root
+      @target_root = '/usr/local/'
       @commands = []
       @errors = {}
       @owner = nil
@@ -170,10 +171,13 @@ module Jeni
     end
     
     # copy a file from the source, relative to the gem home to the target
-    # which is absolute
+    # 
+    # If the target is relative it will joined to the target_root, which is
+    # by default /usr/local. This root can be changed to /usr with either
+    # {Jeni::Options.usr} or through {Jeni::Optparse}.
     # 
     # @param [String] source is the gem-relative path to the file to copy
-    # @param [String] target is an absolute path to copy to
+    # @param [String] target is a relative or absolute path to copy to
     # @params [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
@@ -187,11 +191,11 @@ module Jeni
       chmod = opts[:chmod]
       
       gsource = check_file(source)
-      check_target(target, owner)
+      gtarget = check_target(target, owner)
       check_chmod(chmod)
       
-      @commands << {:file => [gsource, target]}
-      process_options(opts, target)
+      @commands << {:file => [gsource, gtarget]}
+      process_options(opts, gtarget)
     end
     
     # copy all of the files in the source directory to the target directory
@@ -298,11 +302,11 @@ module Jeni
       opts[:chgrp] = locals.delete(:chgrp)
       
       gsource = check_file(source)
-      check_target(target, opts[:owner])
+      gtarget = check_target(target, opts[:owner])
       check_chmod(opts[:chmod])
       
-      @commands << {:generate => [gsource, target, locals]}
-      process_options(opts, target)
+      @commands << {:generate => [gsource, gtarget, locals]}
+      process_options(opts, gtarget)
     end
     
     # as for {Jeni::Installer#template} but searches for the source template from a list of predefined
@@ -318,11 +322,11 @@ module Jeni
       opts[:chmod] = locals.delete(:chmod)
       opts[:chgrp] = locals.delete(:chgrp)
       
-      check_target(target, opts[:owner])
+      gtarget = check_target(target, opts[:owner])
       check_chmod(opts[:chmod])
       
-      @commands << {:generate => [gsource, target, locals]}
-      process_options(opts, target)
+      @commands << {:generate => [gsource, gtarget, locals]}
+      process_options(opts, gtarget)
     end
     
     # create a wrapper script at target to call source in a similar manner to Gem's wrapper
@@ -341,10 +345,10 @@ module Jeni
       
       check_gem(:wrapper)
       gsource = check_file(source)
-      check_target(target, owner)
+      gtarget = check_target(target, owner)
       
-      @commands << {:wrap => [source, target, gsource]}
-      @commands << {:chmod => {:file => target, :mode => 0755}} if opts.has_key?(:chmod)
+      @commands << {:wrap => [source, gtarget, gsource]}
+      @commands << {:chmod => {:file => gtarget, :mode => 0755}} if opts.has_key?(:chmod)
     end
     
     # create a link at target to source
@@ -355,8 +359,8 @@ module Jeni
     def link(source, target)
       #gsource = File.expand_path(File.join(@source_root, source))
       gsource = check_file(source)
-      check_target(target)
-      @commands << {:link => [gsource, target]}
+      gtarget = check_target(target)
+      @commands << {:link => [gsource, gtarget]}
     end
     
     # output a message in the same format as other messages

data/lib/jeni/options.rb

@@ -63,6 +63,11 @@ module Jeni
       @group = group
     end
     
+    # set the default target root to /usr instead of /usr/local
+    def usr
+      @target_root = '/usr/'
+    end
+    
   end
   
 end

data/lib/jeni/optparse.rb

@@ -69,6 +69,10 @@ module Jeni
         @group = g
       end
       
+      opts.on('-u', '--usr', 'set the default target to /usr instead of /usr/local') do
+        @target_root = '/usr/'
+      end
+      
       opts.on_tail('-h', '--help', 'you are looking at it') do
         puts opts
         exit 0

data/lib/jeni/utils.rb

@@ -43,6 +43,9 @@ module Jeni
     # this will create a target if it does not exist (and all intermediate paths) unless
     # the nomkdir option is set
     def check_target(target, owner=nil)
+      unless target[0,1] == '/' 
+        target = File.expand_path(File.join(@target_root, target))
+      end
       dir = File.dirname(target)
       unless FileTest.directory?(dir)
         unless @nomkdir 
@@ -50,13 +53,15 @@ module Jeni
           if owner then
             @commands << {:chown => {:file => dir, :owner => owner}}
           end
-          return
+          return target
         end
         @errors[:missing] = dir 
       end
       @errors[:unwritable] = dir unless FileTest.writable?(dir)
+      return target
     rescue
       @errors[:unwritable] = dir unless FileTest.writable?(dir)
+      return target
     end
     
     # ensure this is called for a gem

data/lib/jeni/version.rb

@@ -1,13 +1,14 @@
 # Created by Jevoom
 #
-# 04-Oct-2012
-#   Application forked from local 'jeni' due to Gam-space name clash.
+# 26-Oct-2012
+#   Added relative paths to targets that can take /usr/ or /usr/local as their root.
+#   Got rspec tests to work
 
 module Jeni
-  # version set to 0.2.0
-  Version = '0.2.0'
-  # date set to 04-Oct-2012
-  Version_Date = '04-Oct-2012'
-  #ident string set to: jeni-0.2.0 04-Oct-2012
-  Ident = 'jeni-0.2.0 04-Oct-2012'
+  # version set to 0.2.1
+  Version = '0.2.1'
+  # date set to 26-Oct-2012
+  Version_Date = '26-Oct-2012'
+  #ident string set to: jeni-0.2.1 26-Oct-2012
+  Ident = 'jeni-0.2.1 26-Oct-2012'
 end

data/spec/jeni_utils_spec.rb

@@ -24,6 +24,7 @@ class JeniUtils
   include Jeni::Utils
   include Jeni::Options
   include Jeni::IO
+  include Jeni::Actions
   def initialize
     @app_name = 'jeni'
     @errors = {}
@@ -114,14 +115,16 @@ describe Jeni do
     source_old = File.join(test_dir,  'source', 'jeni.rb')
     source = File.join(test_dir,  'source', 'jeni-diff.rb')
     target = File.join(test_dir,  'target', 'jeni.rb')
-    diff = Diffy::Diff.new(source, target, :source=>'files').to_s(:color)
+    diff = Diffy::Diff.new(target, source, :source=>'files').to_s(:color)
     response = @jeni.say(:exists, target, :warning, true)
     response2 = @jeni.say(:skipping, target, :warning, true)
-    @jeni.should_receive(:puts).with(response)
-    @jeni.should_receive(:puts).with(response2)
-    @jeni.should_receive(:print).twice
-    @jeni.should_receive(:gets).and_return('d', 'n')
+    @jeni.should_receive(:puts).once.with(response)
+    @jeni.should_receive(:print).once
+    @jeni.should_receive(:gets).and_return('d')
     @jeni.should_receive(:puts).with(diff)
+    @jeni.should_receive(:print).once
+    @jeni.should_receive(:gets).and_return('n')
+    @jeni.should_receive(:puts).once.with(response2)
     #@jeni.should_receive(:print)
     @jeni.copy(source, target).should be_nil
     FileTest.exists?(target).should be_true

data/test/examples/target/jeni_template.rb

@@ -0,0 +1,10 @@
+# Author: Robert Sharp
+# Created at: 16:14 25-10-12
+
+module Amodule
+  class Aclass
+    def amethod
+      puts "Welcome"
+    end
+  end
+end

data/test/examples/target/shebang.rb

@@ -0,0 +1,3 @@
+#! /usr/bin/ruby -w
+
+puts "Just a test"

data/test/examples/target/test.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby18
+#
+# This file was generated by RubyGems.
+#
+# The application 'jeni' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+# Updated to wrap non-bin executables
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+# check if there is a version spec here, e.g.: gem_name _0.1.2_ args
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    # there is, so get it
+    version = $1
+    ARGV.shift
+  end
+end
+
+gem_spec = Gem::Specification.find_by_name('jeni', version)
+gem_path = File.join(gem_spec.gem_dir, 'source/jeni.rb')
+
+gem 'jeni', version
+load gem_path

data/test/examples/target2/jeni-diff.rb

@@ -0,0 +1,64 @@
+#
+# Author:: R.J.Sharp
+# Email:: robert(a)osburn-sharp.ath.cx
+# Copyright:: Copyright (c) 2012 
+# 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 LICENCE. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+#
+# 
+# [requires go here]
+require 'rubygems'
+require 'jerbil'
+
+# = Jeni
+#
+# [Description of the main module]
+module Jeni
+  class Installer
+    
+    def initialize(gem_name)
+      @gem_name = gem_name
+      @gem_spec = Gem::Specification.find_by_name(@gem_name)
+      @commands = []
+    end
+    
+    def self.construct(gem_name, options={}, &block)
+      @pretend = options[:pretend] || true # JUST FOR NOW!
+      installer = self.new(gem_name)
+      block.call(installer)
+      return self
+    end
+    
+    def run!(pretent=false)
+      
+    end
+    
+    # copy a file from the source, relative to the gem home to the target
+    # which is absolute
+    def file(source, target, opts={})
+      @commands << {:file => {source => target}}
+      if opts.has_key?(:chown) then
+        @commands << {:chown => opts[:chown]}
+      end
+    end
+    
+    # copy all of the files in a directory
+    def directory(source, target, opts={})
+      
+    end
+    
+    # create a wrapper at target to call source
+    def wrapper(source, target)
+      
+    end
+    
+    def link(source, target)
+      
+    end
+    
+  end
+end

data/test/examples/target2/{jenny_template.rb → jeni_template.rb}

@@ -1,5 +1,5 @@
 # Author: Me
-# Created at: 10:28 14-09-12
+# Created at: 16:15 25-10-12
 
 module Amodule
   class Aclass

data/test/examples/target2/std_template.rb

@@ -1,6 +1,6 @@
 # THIS IS A STANDARD TEMPLATE
 # Author: Robert
-# Created at: 10:28 14-09-12
+# Created at: 16:15 25-10-12
 
 module Amodule
   class Aclass

data/test/examples/target2/subfiles/subfile_1.rb

@@ -0,0 +1,63 @@
+#
+# Author:: R.J.Sharp
+# Email:: robert(a)osburn-sharp.ath.cx
+# Copyright:: Copyright (c) 2012 
+# 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 LICENCE. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+#
+# 
+# [requires go here]
+require 'rubygems'
+
+# = Jeni
+#
+# [Description of the main module]
+module Jeni
+  class Installer
+    
+    def initialize(gem_name)
+      @gem_name = gem_name
+      @gem_spec = Gem::Specification.find_by_name(@gem_name)
+      @commands = []
+    end
+    
+    def self.construct(gem_name, options={}, &block)
+      @pretend = options[:pretend] || true # JUST FOR NOW!
+      installer = self.new(gem_name)
+      block.call(installer)
+      return self
+    end
+    
+    def run!(pretent=false)
+      
+    end
+    
+    # copy a file from the source, relative to the gem home to the target
+    # which is absolute
+    def file(source, target, opts={})
+      @commands << {:file => {source => target}}
+      if opts.has_key?(:chown) then
+        @commands << {:chown => opts[:chown]}
+      end
+    end
+    
+    # copy all of the files in a directory
+    def directory(source, target, opts={})
+      
+    end
+    
+    # create a wrapper at target to call source
+    def wrapper(source, target)
+      
+    end
+    
+    def link(source, target)
+      
+    end
+    
+  end
+end

data/test/examples/test1.rb

@@ -7,7 +7,7 @@ require 'rspec/mocks/standalone'
 
 gspec = double("Gem::Specification")
 Gem::Specification.stub(:find_by_name).and_return(gspec)
-test_dir = File.dirname(__FILE__)
+test_dir = File.expand_path(File.dirname(__FILE__))
 target_dir = File.join(test_dir, 'target2')
 FileUtils.mkdir(target_dir) unless FileTest.directory?(target_dir)
 FileUtils.rm_f Dir.glob("#{target_dir}/**")
@@ -26,5 +26,5 @@ Jeni::Installer.new_from_gem('jeni') do |jeni|
   jeni.wrapper('source/executable', File.join(target_dir, 'executable'), :chmod=>true)
   jeni.link('source/jeni.rb', File.join(target_dir, 'jeni_link.rb'))
   jeni.link('source/shebang.rb', File.join(target_dir, 'jeni_link.rb'))
-  jeni.link('/etc/conf.d/unicorn', File.join(target_dir, 'unicorn.jeni'))
+  jeni.link('/etc/init.d/unicorn', File.join(target_dir, 'unicorn.jeni'))
 end.run!

data/test/examples/test2.rb

@@ -4,7 +4,7 @@ require 'rubygems'
 $LOAD_PATH.unshift File.expand_path('../../lib', File.dirname(__FILE__))
 require 'jeni'
 
-test_dir = File.dirname(__FILE__)
+test_dir = File.expand_path(File.dirname(__FILE__))
 target_dir = File.join(test_dir, 'target2')
 FileUtils.mkdir(target_dir) unless FileTest.directory?(target_dir)
 FileUtils.rm_f Dir.glob("#{target_dir}/**")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jeni
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Dr Robert
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-04 00:00:00 Z
+date: 2012-10-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -94,13 +94,13 @@ files:
 - spec/spec_helper.rb
 - spec/jeni_spec.rb
 - spec/jeni_utils_spec.rb
-- test/examples/source/jenny-diff.rb
-- test/examples/source/jenny.rb
 - test/examples/source/shebang.rb
 - test/examples/source/executable
 - test/examples/source/template.haml.rb
 - test/examples/source/coati.haml.conf
 - test/examples/source/subfiles/subfile_1.rb
+- test/examples/source/jeni.rb
+- test/examples/source/jeni-diff.rb
 - test/examples/test1.rb
 - test/examples/test_args
 - test/examples/test2.rb
@@ -114,17 +114,22 @@ files:
 - test/examples/target/archive/coati.haml.conf
 - test/examples/target/archive/subfiles/subfile_1.rb
 - test/examples/target/jenny_link.rb
-- test/examples/target2/jenny_test.rb
-- test/examples/target2/jenny.rb
+- test/examples/target/test.rb
+- test/examples/target/jeni.rb
+- test/examples/target/jeni_template.rb
+- test/examples/target/shebang.rb
+- test/examples/target2/subfiles/subfile_1.rb
+- test/examples/target2/jeni_test.rb
+- test/examples/target2/jeni.rb
 - test/examples/target2/shebang.rb
-- test/examples/target2/jenny-diff.rb
 - test/examples/target2/executable
 - test/examples/target2/template.haml.rb
 - test/examples/target2/coati.haml.conf
-- test/examples/target2/jenny_template.rb
+- test/examples/target2/jeni-diff.rb
+- test/examples/target2/jeni_template.rb
 - test/examples/target2/coati.conf
 - test/examples/target2/std_template.rb
-- test/examples/target2/jenny_link.rb
+- test/examples/target2/jeni_link.rb
 homepage: 
 licenses: 
 - Open Software Licence v3.0