of_if 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 866744c69f8497c6aabe717358c8dc0fc4ab21d329e7cf3d63f6e99a4a9d22d1
+  data.tar.gz: 109d70562d20203a64886fe6398381bd8935efa2d83585e2fa318fba98f52db3
+SHA512:
+  metadata.gz: f4ca337c13f2edefa5d5d8f1b9f9eb106761659d867ed3815d6d95facf2460f1c2c05abb64832df38a24af5e26c413f7e8fd00bf5e1511a73e772c4bee7420a6
+  data.tar.gz: 22d8755123a0b57ee3b14595a8ed8699f32d08a58db7a572ec8f6e6fc406ae2cf8cfcc0265aaf389a51a29ce6db45d084409f154bbc4b2fdb57df03a6023fa34

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in of_if.gemspec
+gemspec
+
+gem 'pry'
+gem 'rake', '~> 13.0.6'
+gem 'rspec', '~> 3.12.0'
+gem 'rubocop', '~> 1.48.0'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.19.0'

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    of_if (0.1.0)
+      chunky_png (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    chunky_png (1.4.0)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  of_if!
+  pry
+  rake (~> 13.0.6)
+  rspec (~> 3.12.0)
+  rubocop (~> 1.48.0)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.19.0)
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Christoph Lipautz
+
+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,29 @@
+# Of-If
+
+Generate images of Ruby source code that focus on identation. Discuss on the
+style and find heavy blocks with ease.
+
+![](./lib_of_if_file.png)
+
+## Usage
+
+```sh
+# install the gem
+$ gem install of_if
+# run in your project directory, creates a new dir: ./of_if/
+$ of-if
+$ ls of_if/
+  lib_version.png lib_mygem_application.rb
+```
+
+## Development
+
+```sh
+$ bundle install
+$ bundle exec rake specs
+```
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/of-if

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'of_if'
+
+TARGET_DIR = './of_if'
+
+def create_target_directory
+  FileUtils.mkdir_p TARGET_DIR
+end
+
+def targetfile_from(sourcefile)
+  path, file = File.split sourcefile
+  target_filename = "#{path.gsub('/', '_')}_#{file.split('.')[0]}.png"
+  File.join TARGET_DIR, target_filename
+end
+
+def find_source_files = Dir.glob('**/*.rb')
+
+def exclude_vendor_files(files) = files.reject { |file| file.start_with? 'vendor' }
+
+create_target_directory
+source_files = exclude_vendor_files find_source_files
+source_files.each do |file|
+  OfIf::Image.from_sourcefile(file).write targetfile_from(file)
+end

data/lib/of_if/file.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OfIf
+  # Read a source file and provide each line with indentation and content
+  # length.
+  class File
+    # Line responds to content and indentation length of a single line.
+    Line = Struct.new(:raw) do
+      def comment? = raw.lstrip.start_with?('#')
+      def length = raw.length
+      def content_length = raw.lstrip.length
+      def indent_length = length - content_length
+    end
+
+    def initialize(path) = @path = path
+
+    def lines
+      @lines ||= ::File.readlines(@path).map { |line| Line.new(line.rstrip) }
+    end
+
+    def to_s
+      lines.map do |line|
+        "#{' ' * line.indent_length}#{'█' * line.content_length}"
+      end.join "\n"
+    end
+  end
+end

data/lib/of_if/image.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'chunky_png'
+
+module OfIf
+  # Image renders a source file only by its indentation and obfuscates the code
+  # by displaying only color blocks.
+  class Image
+    DEFAULTS = {
+      margin: 100,
+      char_width: 10,
+      line_height: 20,
+      minimal_width: 480
+    }.freeze
+
+    attr_reader :width
+
+    def initialize
+      @width = minimal_width
+      @image_operations = []
+      @current_line_index = 0
+    end
+
+    def self.from_sourcefile(sourcefile)
+      file = File.new sourcefile
+
+      new.tap do |image|
+        file.lines.each { |line| image << line }
+      end
+    end
+
+    def <<(line)
+      @image_operations << create_image_operation(line, @current_line_index)
+      update_width line.length
+      @current_line_index += 1
+    end
+
+    def height = offset + (@current_line_index * line_height)
+
+    def write(filename)
+      png = ChunkyPNG::Image.new width, height, ChunkyPNG::Color::WHITE
+      @image_operations.each { |op| op.call png }
+      png.save filename
+    end
+
+    DEFAULTS.each_key do |attr_with_default|
+      attr_writer attr_with_default
+
+      define_method(attr_with_default) do
+        instance_variable_get(:"@#{attr_with_default}") || \
+          DEFAULTS[attr_with_default]
+      end
+    end
+
+    private
+
+    def update_width(length)
+      @width = [@width, offset + (length * char_width)].max
+    end
+
+    # ChunkyPNG::Color::PREDEFINED_COLORS[:dimgrey]
+    def comment_color = ChunkyPNG::Color.rgba(0, 0, 0, 55)
+
+    # ChunkyPNG::Color::PREDEFINED_COLORS[:green]
+    def code_color = ChunkyPNG::Color.rgba(0, 255, 0, 255)
+
+    def border_color = ChunkyPNG::Color::TRANSPARENT
+
+    def line_color(line)
+      line.comment? ? comment_color : code_color
+    end
+
+    def offset = (2 * margin)
+
+    def spacer = Integer(line_height / 3)
+
+    def create_image_operation(line, line_index)
+      lambda { |png|
+        return if line.length.zero?
+
+        from = rect_start_point line, line_index
+        to = rect_end_point line, line_index
+        png.rect from[0], from[1], to[0], to[1], border_color, line_color(line)
+      }
+    end
+
+    def rect_start_point(line, index)
+      [margin + (line.indent_length * char_width),
+       margin + (index * line_height)]
+    end
+
+    def rect_end_point(line, index)
+      [margin + (line.length * char_width) - spacer,
+       margin + (index * line_height) + line_height - spacer]
+    end
+  end
+end

data/lib/of_if/version.rb

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

data/lib/of_if.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'of_if/version'
+require_relative 'of_if/file'
+require_relative 'of_if/image'
+
+module OfIf
+  class Error < StandardError; end
+end

data/of_if.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'lib/of_if/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'of_if'
+  spec.version = OfIf::VERSION
+  spec.authors = ['Christoph Lipautz']
+  spec.email = ['christoph@lipautz.org']
+
+  spec.summary = 'Generate images of identation from Ruby source code'
+  spec.description = <<~DESC
+    Generate images of Ruby source code that focus on identation. Discuss on
+    the style and find heavy blocks with ease.
+  DESC
+  spec.homepage = 'https://github.com/unused/of-if'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  # spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.  The
+  # `git ls-files -z` loads the files in the RubyGem that have been added into
+  # git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'bin'
+  spec.executables << 'of-if'
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'chunky_png', '~> 1.4'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/sig/of_if.rbs

@@ -0,0 +1,4 @@
+module OfIf
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: of_if
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christoph Lipautz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: |
+  Generate images of Ruby source code that focus on identation. Discuss on
+  the style and find heavy blocks with ease.
+email:
+- christoph@lipautz.org
+executables:
+- of-if
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/of-if
+- lib/of_if.rb
+- lib/of_if/file.rb
+- lib/of_if/image.rb
+- lib/of_if/version.rb
+- lib_of_if_file.png
+- of_if.gemspec
+- sig/of_if.rbs
+homepage: https://github.com/unused/of-if
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/unused/of-if
+  source_code_uri: https://github.com/unused/of-if
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Generate images of identation from Ruby source code
+test_files: []