cheap_coder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23428dc000cbf99177eaae110a76c95afa23915ed9d78bbbf323184001d5a171
+  data.tar.gz: 1533efcc940e9c6eacf517760d69b0e2df782fc173175b00dfb4c1fd4d6410ac
+SHA512:
+  metadata.gz: 9ea49f36d027d9a720dab4785f75098cc0ee567ce4ee2c0b9efb69989f7430f97d42515ce5a96edd46ccc2c0289ff425949677d6e751afeb99575f44e4f698cb
+  data.tar.gz: 395594efeebfabb96fa21e46c0883970a62c25be665277a5ba3e896d58934f78c0248d20c91c2ab5bf1bc59c4ba41afb1abae94f6c81c252d859f33a9913a57a

data/.env.sample

@@ -0,0 +1 @@
+CHEAP_CODER_LOGGER_VERBOSE=false

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.4
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Exclude:
+    - '*.gemspec'
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: diff_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: diff_comma
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+3.4.5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-08-03
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Daiji Tsutsui
+
+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,45 @@
+# CheapCoder
+
+The **CheapCoder** gem can censor Ruby scripts.
+
+This allows only non-structed scripts which do not contain any shell command.
+
+## Usage
+
+The sample code below provides a script [samples/sample1.rb](https://github.com/daiji-tsutsui/cheap_coder/blob/develop/samples/sample1.rb) rejected any built-in methods, *e.g.* `puts` and `==` (received by a constant).
+```ruby
+require 'cheap_coder'
+require 'parser/current'
+
+CODEPATH = 'samples/sample1.rb'
+
+expr = Parser::CurrentRuby.parse(File.read(CODEPATH))
+censor = CheapCoder::Censor.new
+expr = censor.process(expr)
+puts Unparser.unparse(expr)
+```
+
+The censor rejects also any shell commands.
+For example, please see the censord result of [samples/sample2.rb](https://github.com/daiji-tsutsui/cheap_coder/blob/develop/samples/sample1.rb).
+
+### Whitelist
+One can set a whitelist of methods.
+The sample below provides a script admits the build-in `puts`.
+```ruby
+method_whitelist = %i[puts]
+censor = CheapCoder::Censor.new(
+  allowed_methods: method_whitelist,
+)
+expr = censor.process(expr)
+```
+
+### Evaluator
+One can set an evaluator to a censor instance.
+For example, the below evaluates the [ABC size metric](https://wiki.c2.com/?AbcMetric) (not strictly).
+```ruby
+censor = CheapCoder::Censor.new(
+  evaluator: CheapCoder::AbcEvaluator.new
+)
+censor.process(expr)
+censor.score # gives ABC size
+```

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/lib/cheap_coder/abc_evaluator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CheapCoder
+  class AbcEvaluator
+    def initialize
+      @detectors = {
+        A: NodeDetector::Assignment.new,
+        B: NodeDetector::Branch.new,
+        C: NodeDetector::Condition.new,
+      }
+    end
+
+    def score
+      @detectors.transform_values(&:score)
+    end
+
+    def check(node)
+      @detectors.each_value do |detector|
+        detector.check(node)
+      end
+    end
+  end
+end

data/lib/cheap_coder/authorizer.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module CheapCoder
+  class Authorizer
+    include AST::Processor::Mixin
+
+    def initialize(allowed_methods)
+      @allowed_methods = allowed_methods || []
+    end
+
+    def allow?(node)
+      raise ArgumentError, "not SEND node: #{node}" unless node.type == :send
+
+      receiver, method = node.to_a
+      return false unless receiver.nil?
+
+      @allowed_methods.include?(method)
+    end
+
+    def on_def(node)
+      print_debug('DEF', node)
+      @allowed_methods.push(node.to_a[0])
+      default_handler(node)
+    end
+
+    def handler_missing(node)
+      default_handler(node)
+    end
+
+    private
+
+    def default_handler(node)
+      node.children.each do |child|
+        next child unless child.is_a?(AST::Node)
+
+        process(child)
+      end
+    end
+
+    def print_debug(msg, node)
+      return unless ENV['DEBUG'] == 'true'
+
+      puts "[#{msg}] #{Unparser.unparse(node)}"
+    end
+  end
+end

data/lib/cheap_coder/censor.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module CheapCoder
+  class Censor
+    include AST::Processor::Mixin
+
+    def initialize(**option)
+      @authorizer = Authorizer.new(option[:allowed_methods])
+      @evaluator = option[:evaluator]
+    end
+
+    def score
+      @evaluator&.score
+    end
+
+    def process(expr)
+      @authorizer.process(expr)
+      super
+    end
+
+    def on_xstr(node)
+      print_debug('!XSTR', node)
+      node.to_a[0]
+    end
+
+    def on_send(node)
+      return node if @authorizer.allow?(node)
+
+      print_debug('!SEND', node)
+      Parser::AST::Node.new(:nil, [])
+    end
+
+    def handler_missing(node)
+      default_handler(node)
+    end
+
+    private
+
+    def default_handler(node)
+      @evaluator&.check(node)
+
+      type = node.type
+      children = node.children.map do |child|
+        next child unless child.is_a?(AST::Node)
+
+        process(child)
+      end
+      Parser::AST::Node.new(type, children)
+    end
+
+    def print_debug(msg, node)
+      return unless ENV['CHEAP_CODER_LOGGER_VERBOSE'] == 'true'
+
+      puts "[#{msg}] #{Unparser.unparse(node)}"
+    end
+  end
+end

data/lib/cheap_coder/node_detector/assignment.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheapCoder
+  module NodeDetector
+    class Assignment < Base
+      def detected?(node)
+        node.type.to_s.end_with?('asgn')
+      end
+    end
+  end
+end

data/lib/cheap_coder/node_detector/base.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CheapCoder
+  module NodeDetector
+    class Base
+      attr_reader :score
+
+      def initialize
+        @score = 0
+      end
+
+      def check(node)
+        return unless detected?(node)
+
+        print_debug(node)
+        @score += 1
+      end
+
+      def print_debug(node)
+        return unless ENV['CHEAP_CODER_LOGGER_VERBOSE'] == 'true'
+
+        class_type = self.class.name.split('::').last
+        puts "[#{class_type}] #{Unparser.unparse(node)}"
+      end
+    end
+  end
+end

data/lib/cheap_coder/node_detector/branch.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheapCoder
+  module NodeDetector
+    class Branch < Base
+      BRANCH_NODES = %i[send csend yield].freeze
+      private_constant :BRANCH_NODES
+
+      def detected?(node)
+        BRANCH_NODES.include?(node.type)
+      end
+    end
+  end
+end

data/lib/cheap_coder/node_detector/condition.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheapCoder
+  module NodeDetector
+    class Condition < Base
+      CONDITION_NODES = %i[if while until for csend block block_pass
+                           rescue when in_pattern and or or_asgn and_asgn].freeze
+      private_constant :CONDITION_NODES
+
+      def detected?(node)
+        CONDITION_NODES.include?(node.type)
+      end
+    end
+  end
+end

data/lib/cheap_coder/version.rb

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

data/lib/cheap_coder.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'parser/current'
+require 'unparser'
+
+module CheapCoder
+  require_relative 'cheap_coder/version'
+  require_relative 'cheap_coder/abc_evaluator'
+  require_relative 'cheap_coder/authorizer'
+  require_relative 'cheap_coder/censor'
+
+  module NodeDetector
+    require_relative 'cheap_coder/node_detector/base'
+    require_relative 'cheap_coder/node_detector/assignment'
+    require_relative 'cheap_coder/node_detector/branch'
+    require_relative 'cheap_coder/node_detector/condition'
+  end
+end

data/samples/sample1.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+FLAG = :B
+
+# This is a test code for parsing ruby syntax
+def main
+  test_print(name)
+end
+
+def name
+  if FLAG == :A
+    'Adam'
+  else
+    'Bob'
+  end
+end
+
+def test_print(name)
+  str = "Hello, #{name}!!"
+  puts str
+end

data/samples/sample2.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+def main
+  shell_result = `ls`
+  puts shell_result
+
+  shell_result2 = %x(pwd) # rubocop:disable Style/CommandLiteral
+  puts shell_result2
+
+  system_result = system('cd ~')
+  puts system_result
+
+  exec_result = exec('ps')
+  puts exec_result
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: cheap_coder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daiji Tsutsui
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: This gem can censor Ruby scripts and only allows non-structed scripts
+  which do not contain any system command.
+email:
+- daiji.tsutsui417@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/cheap_coder.rb
+- lib/cheap_coder/abc_evaluator.rb
+- lib/cheap_coder/authorizer.rb
+- lib/cheap_coder/censor.rb
+- lib/cheap_coder/node_detector/assignment.rb
+- lib/cheap_coder/node_detector/base.rb
+- lib/cheap_coder/node_detector/branch.rb
+- lib/cheap_coder/node_detector/condition.rb
+- lib/cheap_coder/version.rb
+- samples/sample1.rb
+- samples/sample2.rb
+homepage: https://github.com/daiji-tsutsui/cheap_coder
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/daiji-tsutsui/cheap_coder
+  source_code_uri: https://github.com/daiji-tsutsui/cheap_coder
+  changelog_uri: https://github.com/daiji-tsutsui/cheap_coder/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A Ruby script censor who prefers very simple scripts.
+test_files: []