depec 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09d7e12c703037257dfa1e43846e066dd6cccfb86e5cf2edff637db65fd59b58'
+  data.tar.gz: 9ad0579f597c149926f36401e06b9e30cc99cae1eefc30600f482e3673dd14a9
+SHA512:
+  metadata.gz: 41e11661859ed564b59644a10c25e967afe07f2387560454b78de29bad31f4f4a2c76a8636e100fae64c97cf7d82ab1cea3e5154f9f0f8a24db7db06daaf3135
+  data.tar.gz: 7fe8caf06f16979fb00f38d6e0e2b8ac49cadf04f6a4594eeafe7109c3d8efa93d6a376b8caebc0c91b1e879b3487b38b287970ec2f39cc02672f4c897d7d44e

data/.github/workflows/release.yml

@@ -0,0 +1,20 @@
+name: Release
+on:
+  push:
+    tags:
+      - 'v*'
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.3
+          bundler-cache: true
+      - run: |
+          git config --global user.email "me@moeki.dev"
+          git config --global user.name "moekidev"
+      - run: bundle exec rake release
+    env:
+      GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--require rspec-power_assert

data/.ruby-version

@@ -0,0 +1 @@
+3.0.3

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+group :development do
+  gem "bundler", "~> 2.2"
+  gem "rake", "~> 10.0"
+  gem "rspec", "~> 3.0"
+  gem "rspec-power_assert"
+  gem "thor", "~> 1.1"
+  gem "tty-prompt", "~> 0.23"
+  gem "dry-schema", "~> 1.8"
+  gem "yard"
+end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    dry-configurable (0.13.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.1)
+    dry-initializer (3.0.4)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.8.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.5)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    power_assert (1.1.7)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-power_assert (1.1.0)
+      power_assert (~> 1.1.0)
+      rspec (>= 2.14)
+    rspec-support (3.10.3)
+    thor (1.1.0)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    webrick (1.7.0)
+    wisper (2.0.1)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.2)
+  dry-schema (~> 1.8)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-power_assert
+  thor (~> 1.1)
+  tty-prompt (~> 0.23)
+  yard
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -0,0 +1,68 @@
+# Depec
+
+Depec analyze project directory's dependency spec.
+It provides CLI to parse files in a project directory and report dependency spec as JSON.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "depec"
+```
+
+And then execute:
+
+    $ bundle
+
+Or:
+
+    $ gem install depec
+
+## Usage
+
+Initialize configuration:
+
+```bash
+depec init
+? Do you want to know whether Ruby is used?:  Yes
+? Do you want to know Ruby version?:  Yes
+? Do you want to know Bundler version?:  Yes
+? Gem name that do you want to know version:  rails, jekyll
+? Do you want to know whether Node.js is used?:  Yes
+? Do you want to know Node.js version?:  Yes
+? Npm package name that do you want to know version:  vue, react
+? Do you want to know whether CircleCI is used?:  Yes
+? Do you want to know CircleCI images?:  Yes
+? Do you want to know whether GitHub Actions is used?:  Yes
+```
+
+Analyze specified directory:
+
+```bash
+depec analyze DIR --config=.depecrc.yml
+{
+  "name": DIR_NAME,
+  "ruby": true,
+  "ruby_version": "2.6.9",
+  "bundler_version": "2.2.32",
+  "rails_gem": null,
+  "jekyll_gem": null,
+  "node": true,
+  "node_version": "14.15.1",
+  "vue_npm": "3.0.7",
+  "react_npm": null,
+  "circle_ci": true,
+  "circle_ci_images": [
+    "cimg/ruby:2.6.9-node",
+    "cimg/postgres:12.9"
+  ],
+  "github_actions": false
+}
+```
+
+If you want to output to JSON file,
+
+```bash
+depec analyze DIR --config=.depecrc.yml --output=out.json
+```

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "depec"
+
+# 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/depec.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "depec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "depec"
+  spec.version       = Depec::VERSION
+  spec.authors       = ["moekidev"]
+  spec.email         = ["me@moeki.dev"]
+  spec.license       = "MIT"
+
+  spec.summary       = "Depec analyzes project's depencency spec."
+  spec.description = <<~EOF
+    Depec analyzes project's dependency spec.
+    It provides CLI to parse files in a project directory and
+    report dependency spec as JSON.
+  EOF
+  spec.homepage      = "https://github.com/modekdev/depec"
+
+  if spec.respond_to?(:metadata)
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/modekdev/depec"
+    spec.metadata["changelog_uri"] = "https://github.com/modekdev/depec"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency "thor", "~> 1.1"
+  spec.add_runtime_dependency "tty-prompt", "~> 0.23"
+  spec.add_runtime_dependency "dry-schema", "~> 1.8"
+end

data/exe/depec

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "depec"
+
+Depec::CLI.start

data/lib/depec/analyzer.rb

@@ -0,0 +1,49 @@
+require_relative 'configuration'
+Dir.glob(__dir__ + '/target/*.rb').each {|f| require_relative f }
+
+module Depec
+  class Analyzer
+    #
+    # @param [String]
+    # @param [Hash]
+    #
+    def initialize(dir, config)
+      @dir = dir
+      @name = File.basename(@dir)
+      @config = Configuration.call(config).to_h
+    end
+
+    #
+    # @return [Hash]
+    #
+    def analyze
+      results = {
+        name: @name
+      }
+
+      @config[:targets].each do |target, options|
+        klass = Object.const_get("Depec::Target::#{target.to_s.split('_').collect!{ |w| w.capitalize }.join}").new(@dir)
+        results[target] = klass.used? if options[:use]
+        if [:ruby, :node].include?(target)
+          results[:"#{target}_version"] = klass.version if options[:version]
+        end
+        if target == :circle_ci
+          results[:circle_ci_images] = klass.images if options[:images]
+        end
+        if target == :ruby
+          results[:bundler_version] = klass.bundler_version if options[:bundler_version]
+          options[:gem_version]&.each do |gem|
+            results[:"#{gem}_gem"] = klass.gem_version(gem)
+          end
+        end
+        if target == :node
+          options[:npm_version]&.each do |npm|
+            results[:"#{npm}_npm"] = klass.npm_version(npm)
+          end
+        end
+      end
+
+      results
+    end
+  end
+end

data/lib/depec/cli.rb

@@ -0,0 +1,54 @@
+require 'json'
+require 'yaml'
+require 'thor'
+require 'tty-prompt'
+
+require_relative 'analyzer'
+require_relative 'initializer'
+require_relative 'configuration'
+
+module Depec
+  class CLI < Thor
+    #
+    # @param [String] dir
+    #
+    desc "analyze DIR", "Analyze project dependency spec"
+    method_option "config", desc: "config", default: Depec::DEFAULT_CONFIG_FILE
+    method_option "output", desc: "output", default: nil
+    def analyze(dir)
+      result = Depec::Analyzer.new(dir, YAML.load_file(options["config"])).analyze
+      if options["output"]
+        File.open(options["output"], "w+") do |f|
+          f.write(result.to_json)
+        end
+      else
+        puts JSON.pretty_generate(result)
+      end
+    end
+
+    desc "init", "Initialize depec configuration"
+    def init
+      prompt = TTY::Prompt.new
+      initializer = Depec::Initializer.new
+
+      answers = {
+        ruby: prompt.yes?("? Do you want to know whether Ruby is used?: "),
+        ruby_version: prompt.yes?("? Do you want to know Ruby version?: "),
+        bundler_version: prompt.yes?("? Do you want to know Bundler version?: "),
+        gem_version: prompt.ask("? Gem name that do you want to know version: ", default: "rails, jekyll", convert: :array),
+        node: prompt.yes?("? Do you want to know whether Node.js is used?: "),
+        node_version: prompt.yes?("? Do you want to know Node.js version?: "),
+        npm_version: prompt.ask("? Npm package name that do you want to know version: ", default: "vue, react", convert: :array),
+        circle_ci: prompt.yes?("? Do you want to know whether CircleCI is used?: "),
+        circle_ci_images: prompt.yes?("? Do you want to know CircleCI images?: "),
+        github_actions: prompt.yes?("? Do you want to know whether GitHub Actions is used?: "),
+      }
+
+      config = initializer.processAnswers(answers)
+
+      File.open(Depec::DEFAULT_CONFIG_FILE, 'w+') do |f|
+        f.write(YAML.dump(config))
+      end
+    end
+  end
+end

data/lib/depec/configuration.rb

@@ -0,0 +1,31 @@
+require 'dry/schema'
+
+module Depec
+  DEFAULT_CONFIG_FILE = '.depecrc.yml'
+end
+
+Depec::Configuration = Dry::Schema.Params do
+  required(:targets).hash do
+    optional(:ruby).hash do
+      optional(:use).filled(:bool)
+      optional(:version).filled(:bool)
+      optional(:bundler_version).filled(:bool)
+      optional(:gem_version).array(:str?)
+    end
+
+    optional(:node).hash do
+      optional(:use).filled(:bool)
+      optional(:version).filled(:bool)
+      optional(:npm_version).array(:str?)
+    end
+
+    optional(:circle_ci).hash do
+      optional(:use).filled(:bool)
+      optional(:images).filled(:bool)
+    end
+
+    optional(:github_actions).hash do
+      optional(:use).filled(:bool)
+    end
+  end
+end

data/lib/depec/initializer.rb

@@ -0,0 +1,34 @@
+module Depec
+  class Initializer
+    attr_accessor :config
+
+    #
+    # @param [Hash] answers
+    # @return 
+    #
+    def processAnswers(answers)
+      Depec::Configuration.call({
+        targets: {
+          ruby: {
+            use: answers[:ruby],
+            version: answers[:ruby_version],
+            bundler_version: answers[:bundler_version],
+            gem_version: answers[:gem_version]
+          },
+          node: {
+            use: answers[:node],
+            version: answers[:node_version],
+            npm_version: answers[:npm_version]
+          },
+          circle_ci: {
+            use: answers[:circle_ci],
+            images: answers[:circle_ci_images]
+          },
+          github_actions: {
+            use: answers[:github_actions]
+          }
+        }
+      }).to_h
+    end
+  end
+end

data/lib/depec/target/base.rb

@@ -0,0 +1,12 @@
+module Depec
+  module Target
+    class Base
+      #
+      # @param [String] dir
+      #
+      def initialize(dir)
+        @dir = dir
+      end
+    end
+  end
+end

data/lib/depec/target/circle_ci.rb

@@ -0,0 +1,37 @@
+module Depec
+  module Target
+    class CircleCi < Base
+      #
+      # @return [String]
+      #
+      def config_file
+        File.join(@dir, '.circleci', 'config.yml')
+      end
+
+      #
+      # @return [Boolean]
+      #
+      def used?
+        File.exists?(config_file)
+      end
+
+      #
+      # @return [Array]
+      #
+      def images
+        images = []
+        return images unless File.exists?(config_file)
+
+        File.open(config_file) do |f|
+          f.each_line do |line|
+            if line.include?(' image:')
+              images << line.match(/image: (?<image>.*)/)[:image]
+            end
+          end
+        end
+
+        images
+      end
+    end
+  end
+end

data/lib/depec/target/github_actions.rb

@@ -0,0 +1,19 @@
+module Depec
+  module Target
+    class GithubActions < Base
+      #
+      # @return [String]
+      #
+      def workflows_dir
+        File.join(@dir, '.github', 'workflows')
+      end
+
+      #
+      # @return [Boolean]
+      #
+      def used?
+        File.exist?(workflows_dir)
+      end
+    end
+  end
+end

data/lib/depec/target/node.rb

@@ -0,0 +1,72 @@
+module Depec
+  module Target
+    class Node < Base
+      #
+      # @return [String]
+      #
+      def node_version_file
+        File.join(@dir, '.node-version')
+      end
+
+      #
+      # @return [String]
+      #
+      def package_json
+        File.join(@dir, 'package.json')
+      end
+
+      #
+      # @return [String]
+      #
+      def yarn_lock
+        File.join(@dir, 'yarn.lock')
+      end
+
+      #
+      # @return [Boolean]
+      #
+      def used?
+        File.exists?(package_json)
+      end
+      
+      #
+      # @return [String]
+      #
+      def version
+        if File.exists?(node_version_file)
+          File.open(node_version_file) { |f| return f.gets.strip }
+        elsif File.exists?(package_json)
+          engine_section = false
+          File.open(package_json) do |f|
+            f.each_line do |line|
+              engine_section = true if line.include?('"engines"')
+              if engine_section && line.include?('"node"')
+                return line.match(/"node": "(?<version>.*)"/)[:version]
+              end
+            end
+          end
+
+          return nil
+        end
+      end
+  
+      #
+      # @param [String] npm
+      # @return [String]
+      #
+      def npm_version(npm)
+        return unless File.exists?(yarn_lock)
+        
+        version_line = false
+        File.open(yarn_lock) do |f|
+          f.each_line do |line|
+            return line.match(/version \"(?<version>.*)\"/)[:version] if version_line
+            version_line = true if line.match?(/^#{npm}@/)
+          end
+        end
+        
+        return nil
+      end
+    end
+  end
+end

data/lib/depec/target/ruby.rb

@@ -0,0 +1,76 @@
+module Depec
+  module Target
+    class Ruby < Base
+      #
+      # @return [String]
+      #
+      def ruby_version_file
+        File.join(@dir, '.ruby-version')
+      end
+
+      #
+      # @return [String]
+      #
+      def gemfile
+        File.join(@dir, 'Gemfile')
+      end
+
+      #
+      # @return [String]
+      #
+      def gemfile_lock
+        File.join(@dir, 'Gemfile.lock')
+      end
+
+      #
+      # @return [Boolean]
+      #
+      def used?
+        File.exists?(gemfile)
+      end
+
+      #
+      # @return [String]
+      #
+      def version
+        return unless File.exists?(ruby_version_file)
+        File.open(ruby_version_file) { |f| return f.gets.strip }
+      end
+
+      #
+      # @return [String]
+      #
+      def bundler_version
+        return unless File.exists?(gemfile_lock)
+
+        version_line = false
+        File.open(gemfile_lock) do |f|
+          f.each_line do |line|
+            return line.strip if version_line
+            version_line = true if line.include?('BUNDLED WITH')
+          end
+        end
+
+        return nil
+      end
+
+      #
+      # @param [String] gem
+      # @return [String]
+      #
+      def gem_version(gem)
+        return unless File.exists?(gemfile_lock)
+        
+        File.open(gemfile_lock) do |f|
+          f.each_line do |line|
+            if line.match?(/ #{gem} \([0-9\.]+\)/)
+              return line.match(/#{gem} \((?<version>.*)\)/)[:version]
+            end
+          end
+        end
+        
+        return nil
+      end
+    end
+  end
+end

data/lib/depec/version.rb

@@ -0,0 +1,3 @@
+module Depec
+  VERSION = "1.0.0"
+end

data/lib/depec.rb

@@ -0,0 +1,2 @@
+require "depec/version"
+require "depec/cli"

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: depec
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- moekidev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: |
+  Depec analyzes project's dependency spec.
+  It provides CLI to parse files in a project directory and
+  report dependency spec as JSON.
+email:
+- me@moeki.dev
+executables:
+- depec
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- depec.gemspec
+- exe/depec
+- lib/depec.rb
+- lib/depec/analyzer.rb
+- lib/depec/cli.rb
+- lib/depec/configuration.rb
+- lib/depec/initializer.rb
+- lib/depec/target/base.rb
+- lib/depec/target/circle_ci.rb
+- lib/depec/target/github_actions.rb
+- lib/depec/target/node.rb
+- lib/depec/target/ruby.rb
+- lib/depec/version.rb
+homepage: https://github.com/modekdev/depec
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/modekdev/depec
+  source_code_uri: https://github.com/modekdev/depec
+  changelog_uri: https://github.com/modekdev/depec
+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: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: Depec analyzes project's depencency spec.
+test_files: []