dead_code_terminator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35a0026a3312154a1c97d73ae012b264a34c32c9d338737aa22ac6922f8635ad
+  data.tar.gz: '079e266498ab09e5a82568a189418befc50890ef7461eecb2b1bce54f5cc7a75'
+SHA512:
+  metadata.gz: fc50239484be93bda9bcb7d015cece2b06f5a4dcc091861b304ead379a0f4253de8195cb1581fe630df122ec8f4c196f311580d636ad8d91691c47c84585622d
+  data.tar.gz: 3ee1ca75f87a1402e1b6e14d7f9d390300759340aef3445d5ed8ab9dd39259056963c5fbe815bebe30413f60ca79a96d08c3cbdc762b8111c89ff83ace3f3d63

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Layout/TrailingWhitespace:
+  Exclude:
+    - spec/**/*rb
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+# Metrics/AbcSize:
+#   Enabled: false
+
+# Metrics/MethodLength:
+#   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*rb
+
+# Lint/UnusedMethodArgument:
+#   Enabled: false

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dead_code_terminator.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"
+gem "rubocop-rake", "~> 0.5"
+gem "rubocop-rspec", "~> 2.3"
+
+gem "pry-byebug" unless ENV["CI"]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Vlad Bokov
+
+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 @@
+# DeadCodeTerminator
+
+This acts like [webpack's DefinePlugin](https://webpack.js.org/plugins/define-plugin/) with minification pass. It allows to eliminate dead code statically, which can be required by regulations.
+
+```ruby
+if ENV['PRODUCTION']
+    :then_branch
+else
+    :else_branch
+end
+```
+
+```ruby
+  
+    :then_branch
+
+        
+
+```
+
+Note: it keeps *precise* code locations (including whitespaces and line-breaks).
+So if you have hotfix patches from upstream - they'll be applied without conflicts.
+
+## TODO
+
+- `unless`
+- `x ? a : b`
+- builtin file tree processing
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "dead_code_terminator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dead_code_terminator.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/dead_code_terminator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dead_code_terminator"
+  spec.version       = DeadCodeTerminator::VERSION
+  spec.authors       = ["Vlad Bokov"]
+  spec.email         = ["vlad@razum2um.me"]
+
+  spec.summary       = "Remove dead conditional branches"
+  spec.description   = "Statically remove dead conditional branches, acts like webpack's DefinePlugin and minifier"
+  spec.homepage      = "https://github.com/razum2um/dead_code_terminator"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/razum2um/dead_code_terminator"
+  spec.metadata["changelog_uri"] = "https://github.com/razum2um/dead_code_terminator"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "parser", ">= 2.5.0.0"
+  spec.add_dependency "unparser", "~> 0.6"
+end

data/exe/dead_code_terminator

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "dead_code_terminator"

data/lib/dead_code_terminator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "parser/current"
+require "unparser"
+require_relative "dead_code_terminator/version"
+require_relative "dead_code_terminator/ast"
+require_relative "dead_code_terminator/cond"
+require_relative "dead_code_terminator/cond/base"
+require_relative "dead_code_terminator/cond/literal"
+require_relative "dead_code_terminator/cond/env_index"
+require_relative "dead_code_terminator/cond/env_fetch"
+
+module DeadCodeTerminator
+  class Error < StandardError; end
+
+  def self.strip(io, env: {})
+    Ast.new(env: env, ast: Unparser.parse(io)).process
+  end
+end

data/lib/dead_code_terminator/ast.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module DeadCodeTerminator
+  class Ast
+    attr_reader :env, :ast
+
+    def initialize(env:, ast:)
+      @env = env
+      @ast = ast
+    end
+
+    def process
+      erase_before!
+      erase_after!
+      rewriter.process
+    end
+
+    private
+
+    def erase_before!
+      rewriter.replace(range(end_pos, (total_end - end_pos)), "\n" * (total_lines - to_line))
+    end
+
+    def erase_after!
+      rewriter.replace(range(0, begin_pos), "\n" * (from_line - 1))
+    end
+
+    def begin_pos
+      new_ast.loc.expression.begin_pos
+    end
+
+    def end_pos
+      new_ast.loc.expression.end_pos
+    end
+
+    def total_end
+      ast.loc.expression.end_pos
+    end
+
+    def from_line
+      new_ast.loc.expression.source_buffer.line_for_position(begin_pos)
+    end
+
+    def to_line
+      new_ast.loc.expression.source_buffer.line_for_position(end_pos)
+    end
+
+    def total_lines
+      ast.loc.last_line
+    end
+
+    def rewriter
+      @rewriter ||= Parser::Source::TreeRewriter.new(buf)
+    end
+
+    def range(from, len = nil)
+      unless len
+        len = from.end - from.begin
+        from = from.begin
+      end
+      Parser::Source::Range.new(buf, from, from + len)
+    end
+
+    def buf
+      @buf ||= ast.loc.expression.source_buffer
+    end
+
+    def new_ast
+      @new_ast ||= case ast.type
+                   when :if then if_ast
+                   else ast
+                   end
+    end
+
+    def if_ast
+      cond, then_branch, else_branch = ast.children
+
+      Cond.nodes.each do |klass|
+        if (value = klass.new(env: env, ast: cond).value)
+          return then_branch if value == Cond::Base::THEN
+          return else_branch if value == Cond::Base::ELSE
+        end
+      end
+    end
+  end
+end

data/lib/dead_code_terminator/cond.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DeadCodeTerminator
+  module Cond
+    @nodes = []
+
+    def self.register(node)
+      @nodes << node
+    end
+
+    def self.nodes
+      @nodes
+    end
+  end
+end

data/lib/dead_code_terminator/cond/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DeadCodeTerminator
+  module Cond
+    class Base
+      THEN = :then
+      ELSE = :else
+
+      attr_reader :env, :ast
+
+      def initialize(env:, ast:)
+        @env = env
+        @ast = ast
+      end
+
+      def value; end
+
+      private
+
+      def s(type, *children)
+        Parser::AST::Node.new(type, children)
+      end
+    end
+  end
+end

data/lib/dead_code_terminator/cond/env_fetch.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DeadCodeTerminator
+  module Cond
+    # ENV.fetch('PRODUCTION')
+    # s(:send,
+    #   s(:const, nil, :ENV), :fetch,
+    #   s(:str, "PRODUCTION"))
+    class EnvFetch < Base
+      def value
+        return if ast.type != :send
+
+        receiver, method, *args = ast.children
+        return unless receiver == s(:const, nil, :ENV) && method == :fetch
+
+        return unless (matched_env_key = given_env_key(args[0]))
+
+        env[matched_env_key] ? THEN : ELSE
+      end
+
+      private
+
+      def given_env_key(ast)
+        env.keys.detect { |key| ast == s(:str, key) }
+      end
+    end
+
+    register EnvFetch
+  end
+end

data/lib/dead_code_terminator/cond/env_index.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DeadCodeTerminator
+  module Cond
+    # ENV['PRODUCTION']
+    # s(:index,
+    #   s(:const, nil, :ENV),
+    #   s(:str, "PRODUCTION"))
+    class EnvIndex < Base
+      def value
+        return if ast.type != :index
+
+        hash, key = ast.children
+        return if hash != s(:const, nil, :ENV)
+
+        return unless (matched_env_key = given_env_key(key))
+
+        env[matched_env_key] ? THEN : ELSE
+      end
+
+      private
+
+      def given_env_key(ast)
+        env.keys.detect { |key| ast == s(:str, key) }
+      end
+    end
+
+    register EnvIndex
+  end
+end

data/lib/dead_code_terminator/cond/literal.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DeadCodeTerminator
+  module Cond
+    class Literal < Base
+      def value
+        return THEN if ast.type == :true
+        return ELSE if ast.type == :false
+      end
+    end
+
+    register Literal
+  end
+end

data/lib/dead_code_terminator/if_env.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DeadCodeTerminator
+  class IfEnv < PlainIf
+    def self.match?(ast); end
+
+    def then_branch; end
+
+    def else_branch; end
+
+    def self.nodes
+      ancestors
+    end
+  end
+end

data/lib/dead_code_terminator/plain_if.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DeadCodeTerminator
+  class PlainIf < Node
+    def self.match?(ast); end
+
+    def then_branch; end
+
+    def else_branch; end
+  end
+end

data/lib/dead_code_terminator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DeadCodeTerminator
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: dead_code_terminator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vlad Bokov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0.0
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Statically remove dead conditional branches, acts like webpack's DefinePlugin
+  and minifier
+email:
+- vlad@razum2um.me
+executables:
+- dead_code_terminator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dead_code_terminator.gemspec
+- exe/dead_code_terminator
+- lib/dead_code_terminator.rb
+- lib/dead_code_terminator/ast.rb
+- lib/dead_code_terminator/cond.rb
+- lib/dead_code_terminator/cond/base.rb
+- lib/dead_code_terminator/cond/env_fetch.rb
+- lib/dead_code_terminator/cond/env_index.rb
+- lib/dead_code_terminator/cond/literal.rb
+- lib/dead_code_terminator/if_env.rb
+- lib/dead_code_terminator/plain_if.rb
+- lib/dead_code_terminator/version.rb
+homepage: https://github.com/razum2um/dead_code_terminator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/razum2um/dead_code_terminator
+  source_code_uri: https://github.com/razum2um/dead_code_terminator
+  changelog_uri: https://github.com/razum2um/dead_code_terminator
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Remove dead conditional branches
+test_files: []