ruby-elm 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab58c13391e7b12c8e4517b88a192398bb5813d5
+  data.tar.gz: 9adb70255ee68c87361efc69ab42f187c476d1f6
+SHA512:
+  metadata.gz: 00f8481b954473056f9ecee4130e81176a638108dd68727775804a312112e3f61c880cdcb030380f67a4b09424c47720f3e733e62d6e5b814b8f1ea023210ad2
+  data.tar.gz: 77c6843cf8f147b1297a0f03837c65ce4c0ad7eed5aecffa6e4afd42e666b68013e3bf4c14077e30798474571da76bde7b5df8876f585a1d4cff975ce91a75f2

data/bin/ruby-elm-make

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'elm'
+require 'elm/bin'
+
+exit Elm::Bin.exec ARGV

data/lib/elm.rb

@@ -0,0 +1,23 @@
+require 'contracts'
+require 'elm/runnable'
+require 'elm/files'
+require 'elm/compiler'
+require 'elm/opt_parser'
+require 'elm/options'
+require 'elm/bin'
+
+# Elm ruby wrapper
+module Elm
+  include Contracts::Core
+  include Contracts::Builtin
+
+  Contract None => Elm::Runnable
+  def self.make
+    Elm::Runnable.new 'elm-make'
+  end
+
+  Contract None => Elm::Compiler
+  def self.compiler
+    Elm::Compiler.with make
+  end
+end

data/lib/elm/bin.rb

@@ -0,0 +1,29 @@
+require 'contracts'
+require 'elm'
+
+module Elm
+  # Executable to be used in CLI
+  class Bin
+    include Contracts::Core
+    include Contracts::Builtin
+
+    # rubocop:disable Metrics/MethodLength
+    Contract ArrayOf[String] => Bool
+    def self.exec(argv)
+      options = Elm::OptParser.parse argv
+      begin
+        compile_output = Elm.compiler.files(argv, with_options: options).to_file
+      rescue ExecutableNotFoundError => executable_not_found
+        $stderr.puts executable_not_found.message
+        exit false
+      rescue CompilerError => compiler_error
+        $stderr.puts compiler_error.message
+        exit false
+      end
+      $stderr.puts compile_output.stderr
+      puts compile_output.stdout
+      true
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/elm/compiler.rb

@@ -0,0 +1,41 @@
+require 'contracts'
+require 'elm/runnable'
+require 'elm/files'
+
+module Elm
+  # Compile a set of elm files with options
+  class Compiler
+    include Contracts::Core
+    include Contracts::Builtin
+
+    Contract Runnable => Compiler
+    def self.with(runnable)
+      Compiler.new runnable
+    end
+
+    Contract ArrayOf[String], KeywordArgs[with_options: Optional[Elm::Options]] => Files # rubocop:disable Metrics/LineLength
+    def files(files_list, with_options: Elm::Options.new)
+      Files.new @make, files_list, with_options
+    end
+
+    # rubocop:disable Lint/DuplicateMethods
+    Contract ArrayOf[String], KeywordArgs[with_options: { output: Maybe[String],
+                                                          yes:    Maybe[Bool],
+                                                          report: Maybe[Symbol],
+                                                          warn:   Maybe[Bool],
+                                                          docs:   Maybe[String] }] => Files # rubocop:disable Metrics/LineLength
+    def files(files_list, with_options: {})
+      files files_list, with_options: Elm::Options.with(with_options)
+    end
+    # rubocop:enable Lint/DuplicateMethods
+
+    private
+
+    Contract Elm::Runnable => Elm::Compiler
+    def initialize(runnable)
+      @make = runnable
+
+      self
+    end
+  end
+end

data/lib/elm/files.rb

@@ -0,0 +1,84 @@
+require 'contracts'
+require 'tempfile'
+require 'elm/runnable'
+require 'elm/options'
+
+module Elm
+  # Error raised if run fail
+  class CompilerError < RuntimeError
+  end
+
+  # Compilation output including status
+  class CompileOutput
+    include Contracts::Core
+    include Contracts::Builtin
+
+    attr_reader :output, :run_status
+
+    Contract String, RunSuccess => CompileOutput
+    def initialize(output, run_status)
+      @output = output
+      @run_status = run_status
+
+      self
+    end
+
+    Contract None => String
+    def stdout
+      @run_status.stdout
+    end
+
+    Contract None => String
+    def stderr
+      @run_status.stderr
+    end
+  end
+
+  # Elm files to be compiled
+  class Files
+    include Contracts::Core
+    include Contracts::Builtin
+
+    Contract Elm::Runnable, ArrayOf[String], Elm::Options => Elm::Files
+    def initialize(make, files, options)
+      @make = make
+      @files = files
+      @options = options.with_yes
+
+      self
+    end
+
+    Contract None => CompileOutput
+    def to_s
+      content = ''
+      run_status = nil
+      Tempfile.open(['elm', '.js']) do |tempfile|
+        run_status = compile @options.with_output(tempfile.path)
+        content = File.read tempfile
+      end
+      CompileOutput.new content, run_status
+    end
+
+    Contract None => CompileOutput
+    def to_file
+      run_status = compile
+      CompileOutput.new @options.output, run_status
+    end
+
+    private
+
+    Contract None => RunSuccess
+    def compile
+      compile @options
+    end
+
+    # rubocop:disable Lint/DuplicateMethods
+    Contract Elm::Options => RunSuccess
+    def compile(options)
+      status = @make.run(@files + options.to_a)
+      raise(CompilerError, status.stderr) if status.is_a? RunError
+      status
+    end
+    # rubocop:enable Lint/DuplicateMethods
+  end
+end

data/lib/elm/opt_parser.rb

@@ -0,0 +1,64 @@
+require 'contracts'
+require 'optparse'
+require 'elm/options'
+
+module Elm
+  # Parse command line options
+  class OptParser
+    include Contracts::Core
+    include Contracts::Builtin
+
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    Contract ArrayOf[String] => Options
+    def self.parse(args)
+      options = Options.new
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: ruby-elm [FILES...] ' \
+          '[--output FILE] [--yes] [--report FORMAT] [--warn] [--docs FILE]'
+
+        opts.separator ''
+        opts.separator 'Available options:'
+
+        opts.on_tail('-h', '--help',
+                     'Show this help text') do
+          puts opts
+          exit
+        end
+
+        opts.on('--output [FILE]',
+                'Write result to the given .html or .js FILE.') do |output|
+          options.output = output
+        end
+
+        opts.on('--yes',
+                'Reply \'yes\' to all automated prompts.') do
+          options.yes = true
+        end
+
+        opts.on('--report [FORMAT]', [:normal, :json],
+                'Format of error and warning reports',
+                '  (normal or json)') do |format|
+          options.report = format
+        end
+
+        opts.on('--warn',
+                'Report warnings to improve code quality.') do
+          options.warn = true
+        end
+
+        opts.on('--docs [FILE]',
+                'Write documentation to FILE as JSON.') do |doc|
+          options.docs = doc
+        end
+
+        opts.separator ''
+        opts.separator 'Examples:'
+      end
+
+      opt_parser.parse! args
+      options
+    end
+  end
+end

data/lib/elm/options.rb

@@ -0,0 +1,158 @@
+require 'contracts'
+
+module Elm
+  # rubocop:disable Metrics/ClassLength
+  # Error raised when trying to set a bad report format
+  class BadReportFormatError < RuntimeError
+  end
+
+  # Options to run elm
+  class Options
+    include Contracts::Core
+    include Contracts::Builtin
+
+    Contract KeywordArgs[output: Optional[String],
+                         yes:    Optional[Bool],
+                         report: Optional[Symbol],
+                         warn:   Optional[Bool],
+                         docs:   Optional[Maybe[String]]] => Options
+    def self.with(output: 'index.html', yes: false, report: :normal,
+                  warn: false, docs: nil)
+      opts = Options.new
+      opts.output = output
+      opts.yes = yes
+      opts.report = report
+      opts.warn = warn
+      opts.docs = docs unless docs.nil?
+      opts
+    end
+
+    Contract Options => Options
+    def self.clone(opts)
+      Options.with(output: opts.output,
+                   yes: opts.yes,
+                   report: opts.report,
+                   warn: opts.warn,
+                   docs: opts.docs)
+    end
+
+    FORMATS = [:normal, :json].freeze
+
+    attr_reader :output, :yes, :report, :warn, :docs
+
+    Contract None => Options
+    def initialize
+      @output = 'index.html'
+      @yes = false
+      @report = :normal
+      @warn = false
+      @docs = nil
+
+      self
+    end
+
+    # rubocop:disable Style/TrivialAccessors
+    Contract String => String
+    def output=(value)
+      # check output is valid
+      @output = value
+    end
+
+    Contract Bool => Bool
+    def yes=(value)
+      @yes = value
+    end
+
+    Contract Symbol => Symbol
+    def report=(value)
+      if FORMATS.index(value).nil?
+        raise BadReportFormatError, "'#{value}' is not a valid report format"
+      end
+      @report = value
+    end
+
+    Contract Bool => Bool
+    def warn=(value)
+      @warn = value
+    end
+
+    Contract String => String
+    def docs=(value)
+      @docs = value
+    end
+    # rubocop:enable Style/TrivialAccessors
+
+    Contract None => ArrayOf[String]
+    def to_a
+      res = []
+      push_output res
+      push_yes res
+      push_report res
+      push_warn res
+      push_docs res
+      res
+    end
+
+    Contract String => Options
+    def with_output(output)
+      opts = Options.clone self
+      opts.output = output
+      opts
+    end
+
+    Contract None => Options
+    def with_yes
+      opts = Options.clone self
+      opts.yes = true
+      opts
+    end
+
+    Contract Symbol => Options
+    def with_report(report)
+      opts = Options.clone self
+      opts.report = report
+      opts
+    end
+
+    Contract None => Options
+    def with_warn
+      opts = Options.clone self
+      opts.warn = true
+      opts
+    end
+
+    Contract String => Options
+    def with_docs(docs)
+      opts = Options.clone self
+      opts.docs = docs
+      opts
+    end
+
+    private
+
+    Contract ArrayOf[String] => Maybe[ArrayOf[String]]
+    def push_output(res)
+      res << '--output' && res << @output unless @output == 'index.html'
+    end
+
+    Contract ArrayOf[String] => Maybe[ArrayOf[String]]
+    def push_yes(res)
+      res << '--yes' if @yes
+    end
+
+    Contract ArrayOf[String] => Maybe[ArrayOf[String]]
+    def push_report(res)
+      res << '--report' && res << @report.to_s unless @report == :normal
+    end
+
+    Contract ArrayOf[String] => Maybe[ArrayOf[String]]
+    def push_warn(res)
+      res << '--warn' if @warn
+    end
+
+    Contract ArrayOf[String] => Maybe[ArrayOf[String]]
+    def push_docs(res)
+      res << '--docs' && res << @docs unless @docs.nil?
+    end
+  end
+end

data/lib/elm/runnable.rb

@@ -0,0 +1,81 @@
+require 'contracts'
+require 'mkmf'
+require 'open3'
+
+module Elm
+  # Error raised if executable not found
+  class ExecutableNotFoundError < RuntimeError
+  end
+
+  # Status if execution of Runnable
+  class RunStatus
+    include Contracts::Core
+    include Contracts::Builtin
+
+    attr_reader :stdout, :stderr
+
+    Contract String, KeywordArgs[with_error: Optional[String]] => RunStatus
+    def initialize(stdout, with_error: '')
+      @stdout = stdout
+      @stderr = with_error
+
+      self
+    end
+  end
+
+  # Status when execution is successful
+  class RunSuccess < RunStatus
+  end
+
+  # Status when execution fail
+  class RunError < RunStatus
+  end
+
+  # Run command
+  class Runnable
+    include Contracts::Core
+    include Contracts::Builtin
+
+    RunStatus = Or[RunSuccess, RunError]
+
+    Contract String => Runnable
+    def initialize(command)
+      @command = command
+
+      unless exists?
+        raise ExecutableNotFoundError,
+              "Please install executable '#{@command}'"
+      end
+
+      self
+    end
+
+    Contract None => RunStatus
+    def run
+      run []
+    end
+
+    # rubocop:disable Lint/DuplicateMethods
+    Contract ArrayOf[String] => RunStatus
+    def run(options)
+      cmd = [@command] + options
+      Open3.popen3(*cmd) do |_i, o, e, t|
+        out = o.read || ''
+        err = e.read || ''
+        if t.value.success?
+          RunSuccess.new out, with_error: err
+        else
+          RunError.new out, with_error: err
+        end
+      end
+    end
+    # rubocop:enable Lint/DuplicateMethods
+
+    private
+
+    Contract None => Bool
+    def exists?
+      !find_executable0(@command).nil?
+    end
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: ruby-elm
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Yves Brissaud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: guard-cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: Executable and ruby library to compiler elm files.
+email: yves.brissaud@gmail.com
+executables:
+- ruby-elm-make
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/ruby-elm-make
+- lib/elm.rb
+- lib/elm/bin.rb
+- lib/elm/compiler.rb
+- lib/elm/files.rb
+- lib/elm/opt_parser.rb
+- lib/elm/options.rb
+- lib/elm/runnable.rb
+homepage: https://github.com/eunomie/ruby-elm
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Elm ruby wrapper
+test_files: []