dockerfile_ast 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Dockerfile.sample

@@ -0,0 +1,21 @@
+# this is a comment
+FROM jeremiahishere/sample
+
+MAINTAINER Jeremiah Hemphill <jeremiah@cloudspace.com>
+
+RUN echo 'hello world'
+RUN['echo', 'hello world']
+
+CMD command param1 param2
+
+EXPOSE 21
+ENV APP_ENV production
+
+ADD source_file.sh target_file.sh
+ENTRYPOINT command param1 param2
+
+USER daemon
+VOLUME ["/data"]
+WORKDIR /path/to/workdir
+
+ONBUILD RUN echo 'hello'

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dockerfile_ast.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jeremiah Hemphill
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# DockerfileAst
+
+Convert a Dockerfile into a very basic ast, then output it as an array or string
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dockerfile_ast'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dockerfile_ast
+
+## Usage
+
+rake parse DOCKERFILE=/path/to/dockerfile
+
+Edit DockerfileAst::Parser's parse method to return an approximation of the AST with to_array or a dockerfile with to_s.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/dockerfile_ast/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'dockerfile_ast'
+
+task :parse do
+  parser = DockerfileAst::Parser.new
+  filename = ENV.has_key?('DOCKERFILE') ? ENV['DOCKERFILE'] : 'Dockerfile.sample'
+  dockerfile = File.read(filename)
+  ast = parser.parse(dockerfile)
+  writer = DockerfileAst::Writer.new(ast)
+  puts writer.write(:string)
+end

data/dockerfile_ast.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dockerfile_ast/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dockerfile_ast"
+  spec.version       = DockerfileAst::VERSION
+  spec.authors       = ["Jeremiah Hemphill"]
+  spec.email         = ["jeremiah@cloudspace.com"]
+  spec.summary       = %q{Convert a Dockerfile into a basic AST}
+  spec.description   = %q{Parse a Dockerfile, the write the parsed data back to a file.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'treetop'
+end

data/lib/dockerfile_ast.rb

@@ -0,0 +1,12 @@
+require "dockerfile_ast/version"
+
+require 'treetop'
+
+require 'dockerfile_ast/nodes/named_nodes'
+require 'dockerfile_ast/nodes/string_literal'
+require 'dockerfile_ast/parser'
+require 'dockerfile_ast/writer'
+
+module DockerfileAst
+  # Your code goes here...
+end

data/lib/dockerfile_ast/dockerfile_grammar.treetop

@@ -0,0 +1,87 @@
+# TODO: create a parameter system the accepts a list of parameters delimited by spaces, or string in an array
+grammar DockerfileGrammar
+  rule body
+    ( instruction / comment / end_of_line )* <DockerfileAst::Node::Dockerfile>
+  end
+
+  rule comment
+    space? '#' space? rest_of_line <DockerfileAst::Node::Comment>
+  end
+
+  rule instruction 
+    space? instruction_type space? end_of_line? <DockerfileAst::Node::Instruction>
+  end
+
+  # INSTRUCTIONS 
+
+  rule instruction_type
+    from / maintainer / run / cmd / expose / env / add / entrypoint / volume / user / workdir / onbuild
+  end
+
+  rule add
+    'ADD' space? rest_of_line <DockerfileAst::Node::AddInstruction>
+  end
+
+  rule cmd
+    'CMD' space? rest_of_line <DockerfileAst::Node::CmdInstruction>
+  end
+
+  rule entrypoint
+    'ENTRYPOINT' space? rest_of_line <DockerfileAst::Node::EntrypointInstruction>
+  end
+
+  rule env
+    'ENV' space? rest_of_line <DockerfileAst::Node::ExposeInstruction>
+  end
+
+  rule expose
+    'EXPOSE' space? rest_of_line <DockerfileAst::Node::ExposeInstruction>
+  end
+
+  rule from
+    'FROM' space? string_without_spaces <DockerfileAst::Node::FromInstruction>
+  end
+
+  rule maintainer
+    'MAINTAINER' space? rest_of_line <DockerfileAst::Node::MaintainerInstruction>
+  end
+
+  rule onbuild
+    'ONBUILD' space? instruction <DockerfileAst::Node::OnbuildInstruction>
+  end
+
+  rule run
+    'RUN' space? rest_of_line <DockerfileAst::Node::RunInstruction>
+  end
+
+  rule user
+    'USER' space? rest_of_line <DockerfileAst::Node::UserInstruction>
+  end
+
+  rule volume
+    'VOLUME' space? rest_of_line <DockerfileAst::Node::VolumeInstruction>
+  end
+
+  rule workdir
+    'WORKDIR' space? rest_of_line <DockerfileAst::Node::WorkdirInstruction>
+  end
+
+  # END INSTRUCTIONS
+
+  rule string_without_spaces
+    [\S]* <DockerfileAst::Node::StringLiteral>
+  end
+
+  rule rest_of_line
+    [^\n]* <DockerfileAst::Node::StringLiteral>
+  end
+
+  rule end_of_line
+    [\n]+
+  end
+
+  # allow whitespace anywhere but match it last
+  rule space
+    [\s]+
+  end
+end

data/lib/dockerfile_ast/nodes/named_nodes.rb

@@ -0,0 +1,96 @@
+module DockerfileAst
+  module Node
+    class NamedNode < Treetop::Runtime::SyntaxNode
+      def title
+        :named_node
+      end
+
+      def to_array
+        [title] + elements.map(&:to_array)
+      end
+
+      def to_s
+        "#{title.to_s.upcase} #{elements_to_s}"
+      end
+
+      def elements_to_s
+        elements.map(&:to_s).join("\n")
+      end
+    end
+
+    class Instruction < NamedNode
+      def title; :instruction end
+
+      def to_s
+        elements_to_s
+      end
+    end
+
+    class Comment < NamedNode
+      def title; :comment end
+
+      def to_s
+        "# #{elements[0].to_s}"
+      end
+    end
+
+    class Dockerfile < NamedNode
+      def title; :dockerfile end
+
+      def to_s
+        elements_to_s
+      end
+    end
+
+
+    #  INSTRUCTIONS
+
+    class AddInstruction < NamedNode
+      def title; :add end
+    end
+
+    class CmdInstruction < NamedNode
+      def title; :cmd end
+    end
+
+    class EntrypointInstruction < NamedNode
+      def title; :entrypoint end
+    end
+
+    class EnvInstruction < NamedNode
+      def title; :env end
+    end
+
+    class ExposeInstruction < NamedNode
+      def title; :expose end
+    end
+
+    class FromInstruction < NamedNode
+      def title; :from end
+    end
+
+    class MaintainerInstruction < NamedNode
+      def title; :maintainer end
+    end
+
+    class OnbuildInstruction < NamedNode
+      def title; :onbuild end
+    end
+
+    class RunInstruction < NamedNode
+      def title; :run end
+    end
+
+    class UserInstruction < NamedNode
+      def title; :user end
+    end
+
+    class VolumeInstruction < NamedNode
+      def title; :volume end
+    end
+
+    class WorkdirInstruction < NamedNode
+      def title; :workdir end
+    end
+  end
+end

data/lib/dockerfile_ast/nodes/string_literal.rb

@@ -0,0 +1,13 @@
+module DockerfileAst
+  module Node
+    class StringLiteral < Treetop::Runtime::SyntaxNode
+      def to_array
+        self.text_value
+      end
+
+      def to_s
+        self.text_value
+      end
+    end
+  end
+end

data/lib/dockerfile_ast/parser.rb

@@ -0,0 +1,28 @@
+module DockerfileAst
+  class Parser
+
+    def initialize
+      Treetop.load(File.expand_path(File.join(File.dirname(__FILE__), 'dockerfile_grammar.treetop')))
+      @parser = DockerfileGrammarParser.new
+    end
+
+    def parse(data, return_type = :string)
+      tree = @parser.parse(data)
+
+      if(tree.nil?)
+        raise Exception, "Parse error at offset: #{@parser.index} #{@parser.failure_reason}"
+      end
+
+      # this edits the tree in place
+      clean_tree(tree)
+
+      return tree
+    end
+  
+    def clean_tree(root_node)
+      return if(root_node.elements.nil?)
+      root_node.elements.delete_if{|node| node.class.name == "Treetop::Runtime::SyntaxNode" }
+      root_node.elements.each {|node| self.clean_tree(node) }
+    end
+  end
+end

data/lib/dockerfile_ast/version.rb

@@ -0,0 +1,3 @@
+module DockerfileAst
+  VERSION = "0.0.1"
+end

data/lib/dockerfile_ast/writer.rb

@@ -0,0 +1,17 @@
+module DockerfileAst
+  class Writer
+    def initialize(tree)
+      @tree = tree
+    end
+
+    def write(return_type = :string)
+      if return_type == :tree
+        return @tree
+      elsif return_type == :array
+        return @tree.to_array
+      else
+        return @tree.to_s
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: dockerfile_ast
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremiah Hemphill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parse a Dockerfile, the write the parsed data back to a file.
+email:
+- jeremiah@cloudspace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Dockerfile.sample
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dockerfile_ast.gemspec
+- lib/dockerfile_ast.rb
+- lib/dockerfile_ast/dockerfile_grammar.treetop
+- lib/dockerfile_ast/nodes/named_nodes.rb
+- lib/dockerfile_ast/nodes/string_literal.rb
+- lib/dockerfile_ast/parser.rb
+- lib/dockerfile_ast/version.rb
+- lib/dockerfile_ast/writer.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Convert a Dockerfile into a basic AST
+test_files: []