rien 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41db30d7cf5c9e875f8d5a6d501d31a870f86db9c6ced2df28b653e3702eb3d2
-  data.tar.gz: 8d80bc19aaebb6598ff34d31c14948974f69157d5d1c5c897d3c834a5ea11377
+  metadata.gz: '0094436a546c52a481feb6536ee79b3fa8927c8ec06e23c31b78fad3d24ecb8d'
+  data.tar.gz: a1de8fccd8397e1ba2494480e083ef9e0c8f5a7f19ddbe179f0e2ec3b2da6196
 SHA512:
-  metadata.gz: eaf3df6e327068cd266cebbf20568458561b7e455380da5274d70dc488dfab3a0c2a5d52e0e4f112738f590df37a79bfbe86d3e72de81dc72fab2f0fa1a6c711
-  data.tar.gz: a3d37be26849827cb354b13719b2c32ecd0cc747a9f7615dcebc073b688d9c47575af25b518ebaed24bde660d27d76f99a617141ec8c397e0048c089b7466d28
+  metadata.gz: f068ad7e92c3920d79bdf09079350eed7494f0046abd9d3b233bd2650b3606ea8b880eb2e79be16da7e5fb18c37b3b705a556cee46dfd9f72e004aaf503d3f7b
+  data.tar.gz: 21550da29e351feb4e6cbb43317d0cb7259fc12f3ab2bd48e032aa0848931afb810b94e663a3079af31a9c78cb9361b398579a9cbed3db1aab5615f10197b624

data/README.md

@@ -0,0 +1,102 @@
+# Rien
+
+Ruby IR Encoding Gem (Experimental)
+
+# Example
+
+```
+Usage: rien [options]
+    -e, --encode [FILE]              Encode specific ruby file
+    -p, --pack [DIR]                 Pack ruby directory into encoded files
+    -o, --out [FILE/DIR]             Indicate the output of the encoded file(s)
+    -u, --use-rienfile               Use Rienfile to configure, override other options
+    -s, --silent-mode                Suppress all prompts asking for user input
+    -t, --tmpdir [DIR]               Select a temp directory to store intermediate results
+```
+
+## Encode Mode
+
+Encode single ruby file
+
+```ruby
+# hello.rb
+
+puts "Hello Rien"
+```
+
+```
+rien -e hello.rb -o encoded.rb
+
+ruby encoded.rb # => Hello Rien
+```
+
+## Pack Mode
+
+### Compile all .rb files in the directory
+
+```
+rien -p source -o output
+```
+
+### Use Rienfile to configure
+
+When using `Rienfile` to configure, other options from CLI will be ignored
+
+Put a `Rienfile` in your project directory
+
+```ruby
+# source/Rienfile
+
+Rien.configure do |config|
+    # The syntax is the same as glob used in class Dir
+    # [Optional] includes all files by default
+    config.includes = ["app/**/*", "lib/**/*"]
+    # [Optional] excludes nothing by default
+    config.excludes = ["**/*.py",
+                       "lib/**/templates/**/*",
+                       "**/init.rb"]
+
+    # [Optional] set to rien_output by default
+    config.output = "compiled"
+
+    # Rien will wait user to input in console when 
+    # finding suspicious already compiled file
+    # set this to true to turn it off
+    # [Optional] set to false by default
+    config.silent = false
+
+    # [Optional] use Dir.tmpdir/rien by default
+    # aka. /tmp/rien for linux
+    config.tmpdir = "tmpdir/rien"
+
+end
+```
+
+and then
+
+```
+rien -p source -u
+```
+### Files to be excluded
+
+#### Read file and eval
+
+Real world code from [redmine/config/initializers/00-core_plugins.rb
+](https://github.com/redmine/redmine/blob/master/config/initializers/00-core_plugins.rb#L14)
+
+```ruby
+eval(File.read(initializer), binding, initializer)
+```
+
+Compile `lib/plugins/**/init.rb` may lead to a such error in runtime
+```
+init.rb:5:in `<main>': undefined local variable or method `config' for main:Object (NameError)
+```
+
+Use `Rinefile` to exclude `lib/plugins/**/init.rb`
+
+### Temporary directory
+
+Rien uses a `tmpdir` to store intermediate results and timestamps to distinguish them.
+
+Check your `tmpdir` (`/tmp/rien` for linux by default) to clean unsuccessful build results.

data/bin/rien

@@ -1,80 +1,5 @@
 #!/bin/ruby
 
-require 'optparse'
-require 'rien'
-require 'fileutils'
-require 'ruby-progressbar'
+require "rien"
 
-options = {
-  mode: :help,
-}
-
-parser = OptionParser.new do |opts|
-  opts.banner = 'Usage: rien [options]'
-  opts.on('-e', '--encode [FILE]', 'Encode specific ruby file', String) do |v|
-    options[:mode] = :encode
-    options[:file] = v
-    options[:output] ||= "output.rb"
-  end
-
-  opts.on('-p', '--pack [DIR]', 'Pack ruby directory into encoded files', String) do |v|
-    options[:mode] = :pack
-    options[:file] = v
-    options[:output] ||= "rien_output"
-  end
-
-  opts.on('-o' '--out [FILE/DIR]', 'Indicate the output of the encoded file(s)', String) do |v|
-    options[:output] = v
-  end
-end
-
-parser.parse!
-
-case options[:mode]
-when :encode
-  encoder = Rien::Encoder.new
-  bytes = encoder.encode_file(options[:file])
-  generated_name = options[:output]
-  # Check if end with .rb and no files generated existing
-
-  File.open("#{generated_name}.rbc", 'wb') do |f|
-    f.write bytes
-  end
-
-  File.open(generated_name, 'w') do |f|
-    f.write encoder.bootstrap
-  end
-when :pack
-  source = options[:file]
-  destination = options[:output]
-  FileUtils.cp_r source, destination
-  encoder = Rien::Encoder.new
-  
-  files = Dir.glob(File.join(destination, "**/*.rb"))
-  progressbar = ProgressBar.create(:title => "Generating", :starting_at => 0, :total => files.length)
-
-  files.each do |path|
-    progressbar.log("Compiling: #{path}")
-    begin
-      bytes = encoder.encode_file(path)
-      File.open("#{path}.rbc", 'wb') do |f|
-        f.write bytes
-      end
-  
-      # Replace file with bootstrap
-      FileUtils.rm(path)
-      File.open(path, 'w') do |f|
-        f.write encoder.bootstrap
-      end
-
-      progressbar.increment
-    rescue Exception
-      # ignore
-      progressbar.increment
-    end
-  end
-when :help
-  puts parser
-else
-  puts parser
-end
+Rien::Cli.new.start

data/lib/rien.rb

@@ -1,7 +1,13 @@
 require 'zlib'
 
+require_relative 'rien/core_ext/string'
+
 require_relative 'rien/version'
 require_relative 'rien/const'
 
+require_relative 'rien/configurable'
+
 require_relative 'rien/decoder'
 require_relative 'rien/encoder'
+
+require_relative 'rien/cli'

data/lib/rien/cli.rb

@@ -0,0 +1,234 @@
+require "optparse"
+require "ruby-progressbar"
+require "fileutils"
+
+module Rien::CliHelper
+  class CliHelperStatus
+    attr_accessor :silent
+
+    def initialize
+      @silent = false
+    end
+  end
+
+  private def status
+    @status ||= CliHelperStatus.new
+  end
+
+  private def encoder
+    @encoder ||= Rien::Encoder.new
+  end
+
+  private def wait_user_on_encoded(path)
+    if path.match(".rbc") && !status.silent
+      print "\n#{path} maybe have already been encoded, continue? (a/y/n) ".yellow
+      user_input = STDIN.gets.chomp.downcase
+      if user_input == "a"
+        status.silent = true # skip all warnings
+      elsif user_input == "y"
+        # ignore
+      else
+        abort("Manually abort".red)
+      end
+    end
+  end
+
+  # Notice:
+  # this path must be relative path, 
+  # or it would break after moving to another directory
+  private def encode(path)
+    wait_user_on_encoded(path)
+
+    begin
+      bytes = encoder.encode_file(path)
+    rescue Exception => e
+      abort "\nFailed to encode #{path}, reason:\n#{e.message}".red
+    end
+
+    bytes
+  end
+
+  private def export_single_encoded(source, output)
+    bytes = encode(source)
+
+    File.open("#{output}.rbc", "wb") do |f|
+      f.write bytes
+    end
+
+    File.open(output, "w") do |f|
+      f.write encoder.bootstrap
+    end
+  end
+
+  private def replace_with_encoded(path)
+    bytes = encode(path)
+
+    # Write encoded file
+    File.open("#{path}.rbc", "wb") do |f|
+      f.write bytes
+    end
+
+    # Replace file with bootstrap
+    FileUtils.rm(path)
+    File.open(path, "w") do |f|
+      f.write encoder.bootstrap
+    end
+  end
+
+  private def pack_files(paths)
+    progressbar = ProgressBar.create(:title => "Generating",
+                                     :starting_at => 0,
+                                     :length => 80,
+                                     :total => paths.length,
+                                     :smoothing => 0.6,
+                                     :format => "%t |%b>>%i| %p%% %a")
+
+    paths.each do |path|
+      progressbar.log("Compiling: #{path}")
+      replace_with_encoded(path) # Wirte encoded file and replace the orginal ruby source file with bootstrap
+      progressbar.increment
+    end
+  end
+
+  private def copy_dir(source, output)
+    FileUtils.mkdir_p output
+    FileUtils.cp_r File.join(source, "."), output
+  rescue Exception => e
+    abort("\nFailed to copy #{source} to #{output}, reason: #{e.message}".red)
+  end
+
+  private def move_dir(source, output)
+    FileUtils.mv "#{source}", output
+  rescue Exception => e
+    abort("\nFailed to move #{source} to #{output}, reason: #{e.message}".red)
+  end
+
+  private def pack_all_files_in_directory(source, output, tmpdir)
+    # Copy to temp workspace
+    time_stamp = Time.now.strftime("%Y%m%d%H%M%S")
+    temp_workspace = File.expand_path(time_stamp, tmpdir)
+    copy_dir(source, temp_workspace)
+
+    # Change to temp workspace
+    source_dir = File.absolute_path(File.dirname(source))
+    Dir.chdir(temp_workspace)
+
+    # Encode
+    files = Dir["./**/*.rb"] # pack all files
+    pack_files(files)
+
+    # Clean up
+    puts "Successed to compile and pack #{source} into #{output}\ntotal #{files.length} file(s)".green
+    Dir.chdir(source_dir)
+    move_dir(temp_workspace, output)
+  end
+
+  private def use_rienfile_to_pack(source)
+    # Eval Rienfile
+    begin
+      rienfile = File.expand_path("Rienfile", source)
+      load rienfile
+    rescue Exception => e
+      abort "\nFailed to load Rienfile, reason:\n#{e.message}".red
+    end
+
+    # Configure
+    status.silent = Rien.config.silent
+    output = Rien.config.output
+    tmpdir = Rien.config.tmpdir
+
+    # Copy to temp workspace
+    time_stamp = Time.now.strftime("%Y%m%d%H%M%S")
+    temp_workspace = File.expand_path(time_stamp, tmpdir)
+    copy_dir(source, temp_workspace)
+
+    # Change to temp workspace
+    source_dir = File.absolute_path(File.dirname(source))
+    Dir.chdir(temp_workspace)
+
+    # Encode
+    files = Rien.config.effective_paths
+    pack_files(files)
+
+    # Clean up
+    puts "Successed to compile and pack #{source} into #{output}\n" \
+         "using #{rienfile}\n" \
+         "total #{files.length} file(s)".green
+    Dir.chdir(source_dir)
+    move_dir(temp_workspace, output)
+  end
+end
+
+class Rien::Cli
+  include Rien::CliHelper
+
+  def initialize
+    @options = {
+      mode: :help,
+    }
+
+    @parser = OptionParser.new do |opts|
+      opts.banner = "Usage: rien [options]"
+      opts.on("-e", "--encode [FILE]", "Encode specific ruby file", String) do |v|
+        @options[:mode] = :encode
+        @options[:file] = v
+        @options[:output] ||= "output.rb"
+      end
+
+      opts.on("-p", "--pack [DIR]", "Pack ruby directory into encoded files", String) do |v|
+        @options[:mode] = :pack
+        @options[:file] = v
+        @options[:output] ||= "rien_output"
+        @options[:tmpdir] ||= "/tmp/rien"
+      end
+
+      opts.on("-o", "--out [FILE/DIR]", "Indicate the output of the encoded file(s)", String) do |v|
+        @options[:output] = v
+      end
+
+      opts.on("-u", "--use-rienfile", "Use Rienfile to configure, override other options", String) do
+        @options[:rienfile] = true
+      end
+
+      opts.on("-s", "--silent-mode", "Suppress all prompts asking for user input", String) do
+        @options[:silent] = true
+      end
+
+      opts.on("-t", "--tmpdir [DIR]", "Select a temp directory to store intermediate results", String) do |v|
+        @options[:tmpdir] = v
+      end
+    end
+  end
+
+  def start
+    @parser.parse!
+    case @options[:mode]
+    when :encode
+      source = @options[:file]
+      output = @options[:output]
+      status.silent = @options[:silent]
+
+      export_single_encoded(source, output)
+
+      puts "Successed to compile #{source} into #{output} and #{output}.rbc".green
+    when :pack
+      source = @options[:file]
+      abort("\nOnly directory can be packed".red) unless File.directory?(source)
+
+      use_rienfile = @options[:rienfile]
+      if use_rienfile # Ignore other options from CLI
+        use_rienfile_to_pack(source)
+      else            # Use options from CLI
+        output = @options[:output]
+        tmpdir = @options[:tmpdir]
+        status.silent = @options[:silent]
+
+        pack_all_files_in_directory(source, output, tmpdir)
+      end
+    when :help
+      puts @parser
+    else
+      puts @parser
+    end
+  end
+end

data/lib/rien/configurable.rb

@@ -0,0 +1,55 @@
+require 'tmpdir'
+
+module Rien::Configurable
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield(config)
+    end
+  end
+
+  class Configuration
+    attr_accessor :includes, :excludes, :output, :tmpdir, :silent
+
+    def initialize
+      @includes = ["**/*"]                            # include all paths by default
+      @output = "rien_output"                         # final result
+      @tmpdir = File.expand_path("rien", Dir.tmpdir)  # store intermediate results
+      @silent = false                                 # see cli.rb wait_user_on_encoded
+    end
+
+    def effective_paths
+      temp_paths = []         # store ruby files and directories
+      effective_paths = []    # only ruby files to be compiled
+
+      @includes.each do |path|
+        path = "./#{path}"
+        temp_paths += Dir[path]
+      end
+
+      unless excludes.nil?
+        @excludes.each do |path|
+          path = "./#{path}"
+          temp_paths -= Dir[path]
+        end
+      end
+
+      temp_paths.each do |path|
+        effective_paths.push(path) unless File.directory?(path) || path.match("Rienfile")
+      end
+
+      effective_paths
+    end
+  end
+end
+
+module Rien
+  include Rien::Configurable
+end

data/lib/rien/core_ext/string.rb

@@ -0,0 +1,21 @@
+class String
+  def colorize(color_code) # ANSI color code
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+
+  def blue
+    colorize(34)
+  end
+end

data/lib/rien/encoder.rb

@@ -3,8 +3,9 @@ class Rien::Encoder
     @version = version
   end
 
-  def encode(str)
-    bytecode = RubyVM::InstructionSequence.compile(str, options: Rien::Const::COMPILE_OPTION)
+  def encode_file(path)
+    # RubyVM::InstructionSequence.compile(source, __FILE__, relative_path, options)
+    bytecode = RubyVM::InstructionSequence.compile(File.read(path), path, path, options: Rien::Const::COMPILE_OPTION)
     Zlib::Deflate.deflate(bytecode.to_binary)
   end
 
@@ -17,8 +18,4 @@ Rien::Decoder.eval("\#{__FILE__}.rbc")
     EOL
   end
 
-  def encode_file(filepath)
-    src = File.read(filepath)
-    self.encode(src)
-  end
 end

data/lib/rien/version.rb

@@ -1,3 +1,3 @@
 module Rien
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rien
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - CodeRemixer
-autorequire: 
-bindir:
-- bin
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2019-08-24 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
@@ -34,19 +33,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - bin/rien
 - lib/rien.rb
+- lib/rien/cli.rb
+- lib/rien/configurable.rb
 - lib/rien/const.rb
+- lib/rien/core_ext/string.rb
 - lib/rien/decoder.rb
 - lib/rien/encoder.rb
 - lib/rien/version.rb
-- rien.gemspec
 homepage: https://github.com/coderemixer/rien
 licenses:
 - Apache-2.0
 metadata:
-  issue_tracker: https://github.com/coderemixer/rien/issues
-post_install_message: 
+  bug_tracker_uri: https://github.com/coderemixer/rien/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -54,15 +56,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.5
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ruby IR Encoding
 test_files: []

data/rien.gemspec

@@ -1,21 +0,0 @@
-require './lib/rien'
-
-Gem::Specification.new do |s|
-  s.name                     = 'rien'
-  s.version                  = Rien::VERSION
-  s.required_ruby_version    = '>=2.4.5'
-  s.date                     = Time.now.strftime('%Y-%m-%d')
-  s.summary                  = 'Ruby IR Encoding'
-  s.description              = 'Encode your Ruby code for distribution'
-  s.authors                  = ['CodeRemixer']
-  s.email                    = ['dsh0416@gmail.com']
-  s.require_paths            = ['lib']
-  s.bindir                   = ['bin']
-  s.executables              = ['rien']
-  s.files                    = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|.resources)/}) } \
-    - %w(README.md CODE_OF_CONDUCT.md CONTRIBUTING.md Gemfile Rakefile my_general.gemspec .gitignore .rspec .codeclimate.yml .rubocop.yml .travis.yml logo.png Rakefile Gemfile)
-  s.homepage                 = 'https://github.com/coderemixer/rien'
-  s.metadata                 = { 'issue_tracker' => 'https://github.com/coderemixer/rien/issues' }
-  s.license                  = 'Apache-2.0'
-  s.add_runtime_dependency     'ruby-progressbar', '~> 1.9'
-end