dockerfile-rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f7550872225ced2ce677f0e8af5022518091692f9b3e85b8e8bf3a464b54e55
-  data.tar.gz: f6f6bc21c3160f00e9595aa9e8b2933d0143d787bdfaed006699d521cfe267ee
+  metadata.gz: 663aa3f090391de7b468e62880fc66e97a5bd7c57a03d0d786f71f75f08f32e6
+  data.tar.gz: 9df143eb94746540c6845ec09a68157c337267c612c76bcb918c50fba7c4c3c5
 SHA512:
-  metadata.gz: b52821ac6315a6728aaa172458751a4603089539058425e42a01ce1b035556d22a7ae6b922f056073b5e8ebc9603b5a01eeca762aee8f64c67ffbf296001a269
-  data.tar.gz: b797d2d4510c97a48bee02309ba18a7af726f8266e72913846242f6c6d3811cf3934d1b8ea3fc24fe2838cd4cf2f643ae63e6f15fb88a72b4b5b8c9ffcb143ab
+  metadata.gz: 2999672e3c952718aeb3bf011b3b472d6e5ae3a7eca6aef9da8466770fa37662cdfeb19a81b96befd8417e29c11e761259e27bfbdcee9593bbd7933c4dc16963
+  data.tar.gz: 7c263c8dd367e0c0bb2fc57590cb851ace3d3fdfd46001179b6fb02e1e475f0ee24693487a6263ebb050eb90895b610c1283dcebd52d718e182b33c2527a5388

data/.github/workflows/rake.yml

@@ -1,6 +1,12 @@
 name: Rake Test
 
-on: [push]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   build:

data/.github/workflows/release.yml

@@ -1,9 +1,8 @@
 name: Release Gem
 
 on:
-  create:
-    tags:
-      - v*
+  release:
+    types: [published]
 
 jobs:
   build:

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## [v0.2.0](https://github.com/gscho/dockerfile-rb/tree/v0.2.0) (2021-09-29)
+
+[Full Changelog](https://github.com/gscho/dockerfile-rb/compare/0.1.0...v0.2.0)
+
+**Implemented enhancements:**
+
+- Add support for variables [\#4](https://github.com/gscho/dockerfile-rb/pull/4) ([gscho](https://github.com/gscho))
+
+**Closed issues:**
+
+- variable looks not supported [\#2](https://github.com/gscho/dockerfile-rb/issues/2)
+
+## [0.1.0](https://github.com/gscho/dockerfile-rb/tree/0.1.0) (2020-05-10)
+
+[Full Changelog](https://github.com/gscho/dockerfile-rb/compare/1908994ec01bb02077da3fb5efc975c90e591716...0.1.0)
+
+**Merged pull requests:**
+
+- Update rake requirement from ~\> 10.0 to ~\> 13.0 [\#1](https://github.com/gscho/dockerfile-rb/pull/1) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -2,7 +2,7 @@
 
 ![](https://github.com/gscho/dockerfile-rb/workflows/Rake%20Test/badge.svg)
     
-The intent of this gem is to use a PEG (citrus) to parse a Dockerfile into a Ruby object .
+The intent of this gem is to use a PEG (citrus) to parse a Dockerfile into a hash of Ruby objects.
 
 ## Installation
 
@@ -27,7 +27,8 @@ Example usage:
 ```
 require 'dockerfile-rb'
 
-dockerfile = DockerfileRB.parse('/path/to/Dockerfile')
+dockerfile = DockerfileRB.parse(File.read('/path/to/Dockerfile'))
+puts dockerfile.inspect
 ```
 
 ## Contributing

data/dockerfile-rb.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_dependency             "citrus"

data/lib/dockerfile-rb/expose.rb

@@ -2,8 +2,12 @@ module DockerfileRB
   class Expose
     attr_reader :port, :protocol
     def initialize(port, protocol)
-      @port = port.to_i
-      @protocol = (protocol || 'tcp').downcase
+      if port.match /\d/
+        @port = port.to_i
+        @protocol = (protocol || 'tcp').downcase
+      else # port is a variable
+        @port = port
+      end
     end
   end
   module ExposeParser

data/lib/dockerfile-rb/grammars/dockerfile.citrus

@@ -24,22 +24,27 @@ grammar DockerfileRB::Dockerfile
     )*
     {
       parsed = matches.map(&:value).compact
-      value = Hash.new {|h,k| h[k] = [] }
-      parsed.each{|p| value[p.class.name.split('::').last.downcase].push p }
-      value
+      results = Hash.new {|h,k| h[k] = [] }
+      parsed.each do |p|
+        key = p.class.name.split('::').last.downcase
+        next if key.eql?('string')
+
+        results[key].push p
+      end
+      results
     }
   end
 
   rule add
-    ('ADD' space arg_term:('--chown=' [a-zA-Z0-9.@/_\-\$\\]+ ':' [a-zA-Z0-9:.@/_\-\$\\]+)? space? src_term:(string) space dest_term:(string) ) <DockerfileRB::AddParser>
+    ('ADD' space arg_term:('--chown=' [a-zA-Z0-9.@/_\-\$\\]+ ':' [a-zA-Z0-9:.@/_\-\$\\]+)? space? src_term:(string | variable) space dest_term:(string | variable) comment?) <DockerfileRB::AddParser>
   end
 
   rule add_with_whitespace
-    ('ADD' space arg_term:('--chown=' [a-zA-Z0-9.@/_\-\$\\]+ ':' [a-zA-Z0-9:.@/_\-\$\\]+)? space? '[' quote src_term:(string_with_whitespace) quote comma quote dest_term:(string_with_whitespace) quote ']' ) <DockerfileRB::AddParser>
+    ('ADD' space arg_term:('--chown=' [a-zA-Z0-9.@/_\-\$\\]+ ':' [a-zA-Z0-9:.@/_\-\$\\]+)? space? '[' quote src_term:(string_with_whitespace | variable) quote comma quote dest_term:(string_with_whitespace | variable) quote ']' comment?) <DockerfileRB::AddParser>
   end
 
   rule arg
-    ('ARG' space arg_name_term:(string) '=' arg_value_term:(string)) <DockerfileRB::ArgParser>
+    ('ARG' space arg_name_term:(string) '=' arg_value_term:(string) comment?) <DockerfileRB::ArgParser>
   end
 
   rule as
@@ -48,32 +53,28 @@ grammar DockerfileRB::Dockerfile
     }
   end
 
-  rule comment
-    '#' space? (string_with_whitespace | '\'' | '=' | '"')* line_break
-  end
-
   rule copy
-    ('COPY' space arg_term:('--chown=' [a-zA-Z0-9.@/_\-\$\\]+ ':' [a-zA-Z0-9:.@/_\-\$\\]+)? space? src_term:(string) space dest_term:(string) ) <DockerfileRB::CopyParser>
+    ('COPY' space arg_term:('--chown=' [a-zA-Z0-9.@/_\-\$\\]+ ':' [a-zA-Z0-9:.@/_\-\$\\]+)? space? src_term:(string | variable) space dest_term:(string | variable) comment?) <DockerfileRB::CopyParser>
   end
 
   rule copy_with_whitespace
-    ('COPY' space arg_term:('--chown=' [a-zA-Z0-9.@/_\-\$\\]+ ':' [a-zA-Z0-9:.@/_\-\$\\]+)? space? '[' quote src_term:(string_with_whitespace) quote comma quote dest_term:(string_with_whitespace) quote ']' ) <DockerfileRB::CopyParser>
+    ('COPY' space arg_term:('--chown=' [a-zA-Z0-9.@/_\-\$\\]+ ':' [a-zA-Z0-9:.@/_\-\$\\]+)? space? '[' quote src_term:(string_with_whitespace | variable) quote comma quote dest_term:(string_with_whitespace | variable) quote ']' comment?) <DockerfileRB::CopyParser>
   end
 
   rule cmd_exec
-    ('CMD' space '[' (quote cmd_term:(string) quote comma?)* ']') <DockerfileRB::CmdParser>
+    ('CMD' space '[' (quote cmd_term:(string) quote comma?)* ']' comment?) <DockerfileRB::CmdParser>
   end
 
   rule cmd_shell
-    ('CMD' space (cmd_term:(string) space?)*) <DockerfileRB::CmdParser>
+    ('CMD' space (cmd_term:(string) space?)* comment?) <DockerfileRB::CmdParser>
   end
 
   rule entrypoint_exec
-    ('ENTRYPOINT' space '[' (quote entrypoint_term:(string) quote comma?)* ']') <DockerfileRB::EntrypointExecParser>
+    ('ENTRYPOINT' space '[' (quote entrypoint_term:(string) quote comma?)* ']' comment?) <DockerfileRB::EntrypointExecParser>
   end
 
   rule entrypoint_shell
-    ('ENTRYPOINT' space (entrypoint_term:(string) space?)*) <DockerfileRB::EntrypointShellParser>
+    ('ENTRYPOINT' space (entrypoint_term:(string) space?)* comment?) <DockerfileRB::EntrypointShellParser>
   end
 
   rule env_with_whitespace
@@ -81,65 +82,70 @@ grammar DockerfileRB::Dockerfile
   end
 
   rule env_key_value
-    ('ENV' space (key_term:(escaped_string) space? '=' quote? space? value_term:(escaped_string) quote? line_continuation?)+) <DockerfileRB::EnvKeyValueParser>
+    ('ENV' space (key_term:(escaped_string) space? '=' quote? space? value_term:(escaped_string | variable) quote? line_continuation?)+ comment?) <DockerfileRB::EnvKeyValueParser>
   end
 
   rule expose
-    ('EXPOSE' space expose_term:(string)) <DockerfileRB::ExposeParser>
+    ('EXPOSE' space expose_term:(string | variable) comment?) <DockerfileRB::ExposeParser>
   end
 
   rule healthcheck_none
-    'HEALTHCHECK NONE' <DockerfileRB::HealthcheckNoneParser>
+    ('HEALTHCHECK NONE' comment?) <DockerfileRB::HealthcheckNoneParser>
   end
 
   rule from
-    ('FROM' space from_term:(string) space? as?) <DockerfileRB::FromParser>
+    ('FROM' space from_term:(string | variable) space? as? comment?) <DockerfileRB::FromParser>
   end
 
   rule label
-    ('LABEL' space label_term:(quote? string_with_whitespace quote? '=' quote? string_with_whitespace quote? line_continuation?)+) <DockerfileRB::LabelParser>
+    ('LABEL' space label_term:(quote? string_with_whitespace quote? '=' quote? (string_with_whitespace | variable) quote? line_continuation?)+ comment?) <DockerfileRB::LabelParser>
   end
 
   rule maintainer
-    ('MAINTAINER' space maintainer_term:(string)) <DockerfileRB::MaintainerParser>
+    ('MAINTAINER' space maintainer_term:(string) comment?) <DockerfileRB::MaintainerParser>
   end
 
   rule run_exec
-    ('RUN' space '[' (quote run_term:(string_with_whitespace) quote comma?)* ']') <DockerfileRB::RunExecParser>
+    ('RUN' space '[' (quote run_term:(string_with_whitespace) quote comma?)* ']' comment?) <DockerfileRB::RunExecParser>
   end
 
   rule run_shell
-    ('RUN' space (run_term:(run_string) space? line_continuation? (comment)*)*) <DockerfileRB::RunShellParser>
+    ('RUN' space (run_term:(run_string) space? line_continuation? (comment)*)* comment?) <DockerfileRB::RunShellParser>
   end
 
   rule stopsignal
-    ('STOPSIGNAL' space signal_term:(signal)) <DockerfileRB::StopsignalParser>
+    ('STOPSIGNAL' space signal_term:(signal | variable) comment?) <DockerfileRB::StopsignalParser>
   end
 
   rule user
-    ('USER' space user_term:(string)) <DockerfileRB::UserParser>
+    ('USER' space user_term:(string | variable) comment?) <DockerfileRB::UserParser>
   end
 
   rule volume_string
-    ('VOLUME' space (volume_term:(string) space?)* (']')?) <DockerfileRB::VolumeStringParser>
+    ('VOLUME' space (volume_term:(string | variable) space?)* (']')?) <DockerfileRB::VolumeStringParser>
   end
 
   rule volume_json
-    ('VOLUME' space '[' (quote volume_term:(string) quote comma?)* ']') <DockerfileRB::VolumeJSONParser>
+    ('VOLUME' space '[' (quote volume_term:(string | variable) quote comma?)* ']') <DockerfileRB::VolumeJSONParser>
   end
 
   rule workdir
-    ('WORKDIR' space quote? workdir_term:(path) quote?) <DockerfileRB::WorkdirParser>
+    ('WORKDIR' space quote? workdir_term:(path | variable) quote? comment?) <DockerfileRB::WorkdirParser>
+  end
+
+  rule comment
+    (space? "#" (~line_break)* line_break?)
   end
 
   rule path
-    [a-zA-Z0-9:.@/_\-\$\[\]\\]+
+    [a-zA-Z0-9:.@/_\-\$\[\]\\{}]+
   end
 
   rule string
-    [a-zA-Z0-9:;!#<>*&^,(){}+#.@/_\-\$\[\]\|$?]+
+    [a-zA-Z0-9:;!<>*&^,()+.@/_\-\[\]\|\?{}]+
   end
 
+
   rule string_with_whitespace
     (string | ' ')+
   end
@@ -149,7 +155,11 @@ grammar DockerfileRB::Dockerfile
   end
 
   rule run_string
-    [a-zA-Z0-9:;!#<>*&^,(){}+#.@/_\-\$\[\]\|$ ='"?]+ | '\\'
+    [a-zA-Z0-9:;!#<>*&^,()+#.@/_\-\$\[\]\| ='"?{}%]+ | '\\'
+  end
+
+  rule variable
+    /^(\\\$|\$)/ string
   end
 
   rule comma

data/lib/dockerfile-rb/version.rb

@@ -1,3 +1,3 @@
 module DockerfileRB
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - gscho
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-10 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -77,9 +77,8 @@ files:
 - ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -127,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A Dockerfile parser implemented in ruby

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 2.0.2

data/Gemfile.lock

@@ -1,37 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dockerfile-rb (0.1.0)
-      citrus
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    citrus (3.0.2)
-    diff-lcs (1.3)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  dockerfile-rb!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.17.3