imagen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ca7133fb04e7eaee106031a74a765bc1950fa166008f1d698fb9324d7d7b04d
+  data.tar.gz: 354ea46d073b496a1e9240c843bfa6193ee59e6460992638167f4c42f8dedc7f
+SHA512:
+  metadata.gz: 5921d7aa4e7b771ba0d48466ff9351d9e71b7a47395d1b2455ecd7475bb6af96ae09fb8abd9e070b6c401b533b007e17e8869e04a8aedba4d31943f799225774
+  data.tar.gz: 1b7d7d85d6f239ad858dca1f655da5b52127f9db2e99b8f51812a9001285c70067d18a62deb6b861dd04630766c47aaf451a934bc9ed04711f7c798c0b7422ec

data/.dockerignore

@@ -0,0 +1 @@
+.git

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.ruby-version
+.ruby-gemset
+.yardoc
+.bundle/
+coverage/
+_yardoc/
+doc/
+pkg/
+spec/reports/
+tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.4.4
+
+Style/RegexpLiteral:
+  EnforcedStyle: slashes
+  AllowInnerSlashes: true
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.4
+before_install:
+  - gem update --system
+  - gem install bundler

data/Dockerfile

@@ -0,0 +1,24 @@
+FROM ruby:2.4.1
+
+# install Git 2.3
+RUN echo "deb http://ppa.launchpad.net/git-core/ppa/ubuntu precise main" \
+          >> /etc/apt/sources.list
+RUN echo "deb-src http://ppa.launchpad.net/git-core/ppa/ubuntu precise main" \
+          >> /etc/apt/sources.list
+RUN apt-key adv --keyserver keyserver.ubuntu.com --recv-keys A1715D88E1DF1F24
+RUN apt-get update && apt-get upgrade -y git
+
+RUN mkdir /imagen
+
+COPY Gemfile* /tmp/
+WORKDIR /tmp
+
+# use a local bundle path for gem inspections
+ENV BUNDLE_PATH /imagen/.bundle
+
+# add /bin to PATH
+ENV BUNDLE_BIN=/imagen/.bundle/bin
+ENV PATH $BUNDLE_BIN:$PATH
+
+WORKDIR /imagen
+ADD . /imagen

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    imagen (0.1.0)
+      parser
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    json (2.1.0)
+    method_source (0.8.2)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    simplecov-lcov (0.7.0)
+    slop (3.6.0)
+    unicode-display_width (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  imagen!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.55.0)
+  simplecov
+  simplecov-lcov
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jan Grodowski
+
+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,7 @@
+# imagen-rb
+
+[![Build Status](https://travis-ci.org/grodowski/imagen_rb.svg?branch=master)](https://travis-ci.org/grodowski/imagen_rb)
+[![codebeat badge](https://codebeat.co/badges/f75bdccf-829b-4139-bcd7-dc68f2c5986b)](https://codebeat.co/projects/github-com-grodowski-imagen-rb-master)
+
+*Representación mental que se tiene de algo.*
+*Mental representation of something.*

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+$LOAD_PATH << 'lib'
+
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop)
+
+desc 'Run Tests'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'imagen_rb'
+
+require 'pry'
+Pry.start

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/build.sh

@@ -0,0 +1 @@
+docker build -t mrgrodo/imagen-rb .

data/imagen_rb.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# rubocop:disable all
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'imagen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'imagen'
+  spec.version       = Imagen::VERSION
+  spec.authors       = ['Jan Grodowski']
+  spec.email         = ['jgrodowski@gmail.com']
+
+  spec.summary       = %q{Codebase as structure of locatable classes and methods based on the Ruby AST}
+  spec.homepage      = "https://github.com/grodowski/imagen_rb"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'parser'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.55.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-lcov'
+end
+# rubocop:enable all

data/lib/imagen.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+$LOAD_PATH << 'lib'
+
+require 'imagen/node'
+require 'imagen/visitor'
+require 'imagen/clone'
+require 'imagen/remote_builder'
+
+# Base module
+module Imagen
+  EXCLUDE_RE = /_(spec|test).rb$/
+
+  def self.from_local(dir)
+    Node::Root.new.build_from_dir(dir)
+  end
+
+  def self.from_remote(repo_url)
+    RemoteBuilder.new(repo_url).build
+  end
+end

data/lib/imagen/clone.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Imagen
+  # Generic clone error
+  class GitError < StandardError; end
+
+  # Responsible for cloning a Git repository into a given tempdir
+  class Clone
+    def self.perform(repo_url, dir)
+      new(repo_url, dir).perform
+    end
+
+    attr_reader :repo_url, :dir
+
+    def initialize(repo_url, dirname)
+      unless repo_url.match?(/^https:\/\/}/)
+        raise ArgumentError, 'repo_url must start with https://'
+      end
+      @repo_url = repo_url
+      @dir = dirname
+    end
+
+    def perform
+      cmd = "GIT_TERMINAL_PROMPT=0 git clone --depth 1 #{repo_url} #{dir}"
+      Open3.popen3(cmd) do |_s_in, _s_out, s_err, wait_thr|
+        err_msg = s_err.read
+        raise GitError, err_msg unless wait_thr.value.exitstatus.zero?
+      end
+    end
+  end
+end

data/lib/imagen/node.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Imagen
+  module Node
+    # Abstract base class
+    class Base
+      attr_reader :ast_node,
+                  :children,
+                  :name
+
+      def initialize
+        @children = []
+      end
+
+      def build_from_ast(ast_node)
+        tap { @ast_node = ast_node }
+      end
+
+      def file_path
+        ast_node.location.name.source_buffer.name
+      end
+
+      def first_line
+        ast_node.location.first_line
+      end
+
+      def line_numbers
+        (first_line..last_line).to_a
+      end
+
+      def last_line
+        ast_node.location.last_line
+      end
+
+      def source
+        source_lines.join("\n")
+      end
+
+      def source_lines_with_numbers
+        (first_line..last_line).zip(source_lines)
+      end
+
+      def source_lines
+        ast_node.location.expression.source_buffer.source_lines[
+          first_line - 1,
+          last_line
+        ]
+      end
+
+      def find_all(matcher, ret = [])
+        ret.tap do
+          ret << self if matcher.call(self)
+          children.each { |child| child.find_all(matcher, ret) }
+        end
+      end
+    end
+
+    # Root node for a given directory
+    class Root < Base
+      attr_reader :dir
+
+      def build_from_dir(dir)
+        @dir = dir
+        list_files.each do |path|
+          begin
+            Imagen::Visitor.traverse(Parser::CurrentRuby.parse_file(path), self)
+          rescue Parser::SyntaxError => err
+            warn "#{path}: #{err} #{err.message}"
+          end
+        end
+        self
+      end
+
+      # TODO: fix wrong inheritance
+      def file_path
+        dir
+      end
+
+      def first_line
+        nil
+      end
+
+      def last_line
+        nil
+      end
+
+      def source
+        nil
+      end
+
+      private
+
+      def list_files
+        return [dir] if File.file?(dir)
+        Dir.glob("#{dir}/**/*.rb").reject { |path| path =~ Imagen::EXCLUDE_RE }
+      end
+    end
+
+    # Represents a Ruby module
+    class Module < Base
+      def build_from_ast(ast_node)
+        super
+        tap { @name = ast_node.children[0].children[1].to_s }
+      end
+    end
+
+    # Represents a Ruby class
+    class Class < Base
+      def build_from_ast(ast_node)
+        super
+        tap { @name = ast_node.children[0].children[1].to_s }
+      end
+    end
+
+    # Represents a Ruby class method
+    class CMethod < Base
+      def build_from_ast(ast_node)
+        super
+        tap { @name = ast_node.children[1].to_s }
+      end
+    end
+
+    # Represents a Ruby instance method
+    class IMethod < Base
+      def build_from_ast(ast_node)
+        super
+        tap { @name = ast_node.children[0].to_s }
+      end
+    end
+  end
+end

data/lib/imagen/remote_builder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'parser/current'
+require 'tmpdir'
+
+module Imagen
+  # RemoteBuilder is responsible for wrapping all operations to create code
+  # structure for a remote git repository.
+  class RemoteBuilder
+    attr_reader :repo_url, :dir
+
+    def initialize(repo_url)
+      @repo_url = repo_url
+      @dir = Dir.mktmpdir
+    end
+
+    def build
+      Clone.perform(repo_url, dir)
+      Imagen::Node::Root.new.build_from_dir(dir).tap { teardown }
+    end
+
+    private
+
+    def teardown
+      FileUtils.remove_entry dir
+    end
+  end
+end

data/lib/imagen/version.rb

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

data/lib/imagen/visitor.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Imagen
+  # AST Traversal that calls respective builder methods from Imagen::Node
+  class Visitor
+    TYPES = {
+      class: Imagen::Node::Class,
+      module: Imagen::Node::Module,
+      defs: Imagen::Node::CMethod,
+      def: Imagen::Node::IMethod
+    }.freeze
+
+    attr_reader :root, :current_root, :file_path
+
+    def self.traverse(ast, root)
+      new.traverse(ast, root)
+      root
+    end
+
+    def traverse(ast_node, parent)
+      return unless ast_node.is_a?(Parser::AST::Node)
+      node = visit(ast_node, parent)
+      ast_node.children.each { |child| traverse(child, node || parent) }
+    end
+
+    # This method reeks of :reek:UtilityFunction
+    def visit(ast_node, parent)
+      klass = TYPES[ast_node.type] || return
+      klass.new.build_from_ast(ast_node).tap do |node|
+        parent.children << node
+      end
+    end
+  end
+end

data/run.sh

@@ -0,0 +1,7 @@
+docker run \
+  --name "imagen-rb" \
+  -it \
+  --rm \
+  -v "$(pwd):/imagen" \
+  --entrypoint bash \
+  mrgrodo/imagen-rb

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: imagen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Grodowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jgrodowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- build.sh
+- imagen_rb.gemspec
+- lib/.gitkeep
+- lib/imagen.rb
+- lib/imagen/clone.rb
+- lib/imagen/node.rb
+- lib/imagen/remote_builder.rb
+- lib/imagen/version.rb
+- lib/imagen/visitor.rb
+- run.sh
+homepage: https://github.com/grodowski/imagen_rb
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Codebase as structure of locatable classes and methods based on the Ruby
+  AST
+test_files: []