packager-dsl 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9260768450b62ac025ad4805f5e2069eeb3a15b2
-  data.tar.gz: f1bc54a12706ed78056f049c9a67bd924c5c36d3
+  metadata.gz: 83e945fadcebe543ffcc791eca75b25c006d98e2
+  data.tar.gz: de066bb4cc80308d485bc1e9762ee0d4a3327a77
 SHA512:
-  metadata.gz: 4f958d50495b3591a90658209c77f93e28e442adee629b3ba47b1c6484760ab0af402c1c9910d218de8dd82c322744e36f8f4d633e604f99c7e7e92f48e6d4eb
-  data.tar.gz: 396b4cdc228dbf227d5b96fc8e96647908a3885695729571751d735861b9c1577feaf04dc18256c14f1a04a06e41ede1f0d56d8669c02ba0ff2788fe61f09f1b
+  metadata.gz: 117fb6a9bca9d53f124f9e2f7d0140423fa9eea4fa330980a4213989bfba31689cb9bbf9752f22ece959bfc44178132809e01fb5609a14a54d9aafcdccac58ee
+  data.tar.gz: 7dd09bd6951ca17bcd53c77e66868c4a1196c469f406b94eb0d2279e213f39e74ca34bb8686b54485e0732704f746795db1a6f199b76b1c27b43b274e4d0a9cd

data/Changes

@@ -1,5 +1,9 @@
 Revision history for Packager (ordered by revision number).
 
+0.1.1 Nov 10 2018
+   - [FEATURE] Add the ability to provide variables
+   - [FEATURE] Add the ability to specify `--dryrun`
+
 0.1.0 Nov 08 2018
    - Update license to MIT
    - Update dsl-maker dependency to 1.0.0 for its license to be MIT

data/README.md

@@ -37,6 +37,29 @@ $ packager execute <filename>
 You now have `foo-0.0.1.x86_64.deb` with several files in it wherever you
 invoked `packager`.
 
+## Command-line options
+
+You can pass in the following options to the packager:
+
+### --dryrun
+
+This is a boolean that, if set, will do everything up to, but not including,
+invoking fpm.
+
+### `--var pkg_name:foo pkg_version:0.0.1`
+
+This will set helpers that can be used within the DSL. The example will set
+the helper `pkg_name` to "foo" and the helper `pkg_version` to "0.0.1".
+
+Due to how Thor works, you must pass multiple variables at the same time. As
+shown above, Thor requires keys and values to be joined by a colon (":").
+
+Consider providing helpers for the following:
+
+* Package version
+* A root directory (so that your source files can be relative to something)
+* Package type (you may want to build a deb vs. an rpm at different times)
+
 ## DSL
 
 * package <name>

data/bin/packager

@@ -1,8 +1,8 @@
-#!/usr/bin/env ruby
-
-$:.unshift File.expand_path('../../lib', __FILE__)
-
-require 'rubygems' unless defined? Gem
-require 'packager/cli'
-
-Packager::CLI.start
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems' unless defined? Gem
+require 'packager/cli'
+
+Packager::CLI.start

data/lib/packager/cli.rb

@@ -18,12 +18,21 @@ class Packager::CLI < Thor
   end
 
   desc :execute, "Execute one or more package DSL definition(s)"
+  option :var, type: :hash
+  option :dryrun, type: :boolean
   default_task :execute
   def execute(*args)
     if args.empty?
       raise Thor::Error, "No filenames provided for execute"
     end
 
+    (options['var'] || {}).each do |name, value|
+      if Packager::DSL.reserved_words.include? name
+        raise Thor::Error, "'#{name}' is a reserved word"
+      end
+      Packager::DSL.add_helper(name.to_sym) { value }
+    end
+
     args.each do |filename|
       unless File.exists? filename
         raise Thor::Error, "'#{filename}' cannot be found"
@@ -39,7 +48,9 @@ class Packager::CLI < Thor
         raise Thor::Error, "'#{filename}' produces nothing"
       end
 
-      packages = Packager::Executor.new.execute_on(items)
+      packages = Packager::Executor.new(
+        dryrun: options['dryrun'],
+      ).execute_on(items)
 
       puts "'#{filename}' executed #{packages.join(', ')}"
     end

data/lib/packager/dsl.rb

@@ -10,6 +10,14 @@ class Packager::DSL < DSL::Maker
       @default_type = args[0] unless args.empty?
       @default_type
     end
+
+    def reserved_words
+      %w(
+        package
+        name version type files file requires provides
+        source dest
+      )
+    end
   end
 
   add_type(VersionString = {}) do |attr, *args|

data/lib/packager/version.rb

@@ -1,3 +1,3 @@
 class Packager
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/cli/execute_spec.rb

@@ -75,5 +75,75 @@ describe Packager::CLI do
         ).to eq("'definition' executed foo, bar\n")
       }
     end
+
+    # NOTE: You (currently) cannot reuse a helper name within the test suite.
+    # Otherwise, you run afoul of add_helper() being called twice with the same
+    # name.
+    context 'variables' do
+      it "handles --var a:b" do
+        package_name = 'foobar'
+        cli.options = {'var' => { 'pkg_name' => package_name } }
+        expect_any_instance_of(Packager::Executor).to(
+          receive(:execute_on).
+          and_return([package_name])
+        )
+
+        append_to_file('definition', '
+          package pkg_name do
+            type "test"
+            version "0.0.1"
+          end
+        ')
+
+        expect(
+          capture(:stdout) { cli.execute('definition') }
+        ).to eq("'definition' executed foobar\n")
+      end
+
+      it "handles --var a:b c:d" do
+        cli.options = {
+          'var' => {
+            'pkg_version' => '0.0.3',
+          }
+        }
+        expect_any_instance_of(Packager::Executor).to(
+          receive(:execute_on) { |_, items|
+            expect(items[0].version).to eq('0.0.3')
+          }.
+          and_return(['foobar'])
+        )
+
+        append_to_file('definition', '
+          package "foobar" do
+            type "test"
+            version pkg_version
+          end
+        ')
+
+        expect(
+          capture(:stdout) { cli.execute('definition') }
+        ).to eq("'definition' executed foobar\n")
+      end
+
+      # This throws an error
+      it "throws an error on --var version:0.0.3" do
+        cli.options = {
+          'var' => {
+            'version' => '0.0.3',
+          }
+        }
+
+        append_to_file('definition', '
+          package "foobar" do
+            type "test"
+            version version
+          end
+        ')
+
+        expect {
+          capture(:stdout) { cli.execute('definition') }
+        }.to raise_error("'version' is a reserved word")
+      end
+    end
   end
 end

data/spec/dsl/add_helper_spec.rb

@@ -0,0 +1,23 @@
+require './spec/dsl/context.rb'
+describe Packager::DSL do
+  context 'adding a helper' do
+    include_context :dsl
+
+    before(:each) do
+      if not subject.class.has_helper? :test_helper
+        subject.class.add_helper(:test_helper) { 'testing' }
+      end
+    end
+
+    it 'finds the test_helper' do
+      items = parse_dsl {
+        package do
+          name test_helper
+          version '0.0.1'
+          type 'test'
+        end
+      }
+      expect(items[0].name).to eq('testing')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packager-dsl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rob Kinyon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2018-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dsl_maker
@@ -219,6 +219,7 @@ files:
 - spec/cli/execute_spec.rb
 - spec/cli/validate_spec.rb
 - spec/cli/version_spec.rb
+- spec/dsl/add_helper_spec.rb
 - spec/dsl/args_spec.rb
 - spec/dsl/context.rb
 - spec/dsl/defaults_spec.rb