byggvir 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33cb21d9027ea23af201468dd6dd94765e6167cf
-  data.tar.gz: 132a76de672b5a45ec7835f9816632d858c3922e
+  metadata.gz: 128d5803e389bf983050284063499d06f33d5b11
+  data.tar.gz: 14c01506592e0f90e601a07b25091f0ffab6566e
 SHA512:
-  metadata.gz: 0cdd028fb88671b4e72951be28829445e3c57f71c1f6ce327d84023fc5bec38ddbdd2535e23774fbae5378deb9d1d0ca57261525d3c8934a797dfe14a0824658
-  data.tar.gz: 1388b8ea08e29506906224c4841a6b90d7841b00f2f1cff67a01344960aa738aa21a257b27958ec89524b38d8097da8206cf32bd2af78c8d396e7d77aa52bff8
+  metadata.gz: f3bf53ab112c99a4115652063ab2d7c388da471f9ef75a9121714bf229ad600c686644618f856749bd103c60591477a4ebc2d4875b62879a08cb34cfdf998812
+  data.tar.gz: 89555404be353f42bbed45a4643c7c08c19ac4605f69d401d562d3edd6da02816e97fdebaed76f9f52a3760fd3109c1dee34c8339592668c96aaf4d8203d7fdc

data/README.md

@@ -3,7 +3,7 @@ byggvir
 
 Byggvir is designed to be the simplest possible command line processing for ruby 2.1
 
-Just require byggvir/simple and off you go! 
+Just require byggvir/simple and off you go!
 
 ```ruby
 require 'byggvir/simple'
@@ -19,17 +19,6 @@ cat_zoo -c "Mr Buttons,spot" -d 5.0
 cat_zoo -c Mephistopheles,Drunky -d 5
 ```
 
-Byggvir::cli will apply to the function you specify
-
-```ruby
-require 'byggvir'
-
-Byggvir::cli,
-def cat_master(cats:)
-    
-end
-```
-
 Byggvir/multiple will match multiple subfunctions
 ```bash
 pet dog -n 5
@@ -42,9 +31,9 @@ require 'byggvir'
 class Pet < Byggvir::Multiple
   doc "The number of dogs",
   def dog(number:)
-  
+
   end
-  
+
   doc "The number of cats",
   def cat(number:)
 

data/lib/byggvir.rb

@@ -1,17 +1,21 @@
 require 'byggvir/static'
 class Byggvir
-  def self.cli(fun)
-    ::Byggvir.wrap(self,cli)
-  end
   class TestObject
   end
   class Multiple
     class << self
+      def create_binaries()
+        directory = File.mkdir(File.basedir($0)+"/bin")
+        list_existing_methods.each{""}
+      end
+
       def doc(doc,name=nil)
         ::Byggvir.error!("doc has to end with a comma, #{caller[1..1]}") unless name.class == Symbol
         @docs||={}
         @docs[name]=doc
       end
+
+      # List existing commands
       def commands(inst)
         unless @docs
           @docs = (inst.methods.to_set - TestObject.new.methods.to_set).map{|meth|
@@ -21,6 +25,8 @@ class Byggvir
         longest = @docs.keys.map(&:length).max
         @docs.map{ |k,v| Kernel.sprintf("% #{longest+1}s : %s",k,v)}.join("\n")
       end
+
+      # Instantiate a multiple function object
       def new(*args)
         inst=super(*args)
         ::Byggvir.error!("Please specify a method, One of: \n#{commands(inst)}") unless ARGV.length>0

data/lib/byggvir/simple.rb

@@ -1,6 +1,7 @@
 require 'byggvir/static'
 class ::Object
   class << self
+    # call function if named same as file
     def method_added(name)
       if name.to_s == File.basename($0,".rb")
         ::Byggvir.wrap(self,self.instance_method(name))

data/lib/byggvir/static.rb

@@ -5,40 +5,58 @@ class Byggvir
   def self.error!(err)
     $stderr.puts("#{$0}:#{err}");$stderr.flush;Process.exit!(-1);
   end
+
+  # get method parameters as hash
   def self.parameters(method)
     method #map argument types
       .parameters
       .map{|ty, na| [na.to_s, ty]}
       .to_h
   end
+
+  # parse arguments
+  def self.interpret(arg)
+    data = YAML.load("---\n[#{arg}]")
+    data.class == Array && data.length == 1 ? data[0] : data
+  end
+
+  # wrap a function
   def self.wrap(instance,method)
     name = method.name
     arguments = ::Byggvir.parameters(method)
+    # Check that function has no non-keyword arguments
     if (badarg = (arguments.values.to_set - [:keyreq, :key].to_set)).empty?
-      required_arguments = arguments.select{|k,v| v == :keyreq}.keys.to_set
+      required_arguments = arguments
+        .select{|k,v| v == :keyreq}
+        .keys
+        .map(&:to_sym)
+        .to_set
+      # Single-letter arguments, first letter, except for duplicates
       short = arguments
         .keys
         .map{|k| {(?- + k[0]) => k}} #prepend dash
-        .reduce{|old, new| old.merge(new){|k, o, n| nil}} #duplicates are uncertain
+        .reduce({}){|old, new| old.merge(new){|k, o, n| nil}}  #Drop duplicates
         .select{|k, v| v != nil}
         .invert
       opts = GetoptLong.new(*arguments.map{|k, v| ["--#{k}", short[k], GetoptLong::REQUIRED_ARGUMENT].compact})
       opts.quiet = true
+
+      # Use getoptlong to parse arguments,
       call = {}
-      unwrap = proc {|w| (w.class == Array && w.length == 1)?w[0]:w }
       begin
-        opts.each{|opt, arg| call[opt[2..-1].to_sym] = unwrap.call(YAML.load("---\n[#{arg}]"))}
+        opts.each{|opt, arg| call[opt[2..-1].to_sym] = ::Byggvir.interpret(arg)}
       rescue GetoptLong::InvalidOption => ex
         ::Byggvir.error!(ex.to_s)
       else
-        if (missing_arguments = (required_arguments - call.keys.map(&:to_s).to_set)).empty?
+        # Call function if all arguments are present
+        if (missing_arguments = (required_arguments - call.keys.to_set)).empty?
           instance.send(name,**call)
         else
           ::Byggvir.error!("Missing arguments to #{name}: #{missing_arguments.to_a.join(?,)}")
         end
       end
     else
-      ::Byggvir.error!("Doesn't support non-hash like function calls. Need something like def(required: ,optional: thing), bad arguments #{badarg}")
+      ::Byggvir.error!("#{name} is not defined correctly, bad arguments #{badarg}\nByggvir can only use optional or mandatory keyword arguments like def(something: other:val)")
     end
   end
 end

data/lib/byggvir/version.rb

@@ -1,3 +1,3 @@
 module Byggvir
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/test/cli.rb~

@@ -0,0 +1,3 @@
+#!/usr/bin/env rvm 2.1.0 do ruby
+$:.push('../lib')
+require 'byggvir'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: byggvir
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Samuel Kleiner
@@ -17,22 +17,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
-- lib/byggvir.rb
 - lib/byggvir/simple.rb
 - lib/byggvir/static.rb
 - lib/byggvir/version.rb
+- lib/byggvir.rb
+- README.md
 - test/doctest.rb
-- test/doctest.rb~
 - test/easy.rb
-- test/easy.rb~
 - test/failing.rb
-- test/failing.rb~
 - test/multiple.rb
-- test/multiple.rb~
 - test/test.rb
-- test/testfrompe.rb~
 - test/update_local.rb
+- test/cli.rb~
+- test/doctest.rb~
+- test/easy.rb~
+- test/failing.rb~
+- test/multiple.rb~
+- test/testfrompe.rb~
 - test/update_local.rb~
 homepage: https://github.com/cultureulterior/byggvir
 licenses:
@@ -44,21 +45,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 3
 summary: Command line tool for ruby2.1
 test_files:
+- test/cli.rb~
 - test/doctest.rb
 - test/doctest.rb~
 - test/easy.rb