compath 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13ff6ad5e1899247bca89f8bd27add568875a13f
+  data.tar.gz: 5ef47ad90cce237d8202eeb9ab200411a57b2b15
+SHA512:
+  metadata.gz: 54aad8dc41dc0a507e69690f0b2173579b0ab7e5876af68fcfaabced03ead3a8ad57f15062238a94fd25c62a08cf031c48f8b0124e346a0abc2fa1c4ec01f93a
+  data.tar.gz: e563de75032cde00c6dba69d43ab0d2b23f9feedaf271e67ed0e6a522709d9abb25e88743e23c28629667497356f5c8bb32cfa84556d109d4909a2d7bfbf9945

data/.compath.yml

@@ -0,0 +1,40 @@
+---
+- ".gitignore":
+    desc:
+- ".rspec":
+    desc: Configuration file for RSpec
+- ".travis.yml":
+    desc: Configuration file for travis
+- bin/:
+    desc:
+- bin/console:
+    desc:
+- bin/setup:
+    desc:
+- compath.gemspec:
+    desc:
+- exe/:
+    desc:
+- exe/compath:
+    desc:
+- Gemfile:
+    desc:
+- lib/:
+    desc:
+- lib/compath/:
+    desc:
+    scan: false
+- lib/compath.rb:
+    desc:
+- LICENSE.txt:
+    desc:
+- Rakefile:
+    desc:
+- README.md:
+    desc:
+- spec/:
+    desc:
+- spec/compath_spec.rb:
+    desc:
+- spec/spec_helper.rb:
+    desc:

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in compath.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 meganemura
+
+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,51 @@
+# Compath
+
+Compath generates a guide of directory structure in the project.
+
+## Installation
+
+    $ gem install compath
+
+## Usage
+
+    $ compath --file=.compath.yml
+
+It creates or updates `.compath.yml`.
+
+```yaml
+- ".gitignore":
+    desc:
+- bin/:
+    desc:
+- bin/console:
+    desc:
+- bin/setup:
+    desc:
+
+...
+```
+
+Each object of sequences has a key to object structure.
+The key means path, and the object is only able to have `desc` or `scan/` keys.
+`desc` is to describe what the path means.
+`scan` is to switch scanning files or not for the directory by configuring boolean value (`true`, `false`).
+
+With the following config, `compath` does not scan files of `bin/` directory.
+
+```yaml
+- ".gitignore":
+    desc:
+- bin/:
+    desc:
+    scan: false
+
+...
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/meganemura/compath.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "compath/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "compath"
+  spec.version       = Compath::VERSION
+  spec.authors       = ["meganemura"]
+  spec.email         = ["meganemura@users.noreply.github.com"]
+
+  spec.summary       = "Compath generates a guide of directory structure in the project"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/meganemura/compath"
+  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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/exe/compath

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "compath"
+require "compath/cli"
+
+Compath::CLI.run

data/lib/compath.rb

@@ -0,0 +1,10 @@
+require "forwardable"
+require "yaml"
+
+require "compath/guide"
+require "compath/guide_book"
+require "compath/finder"
+require "compath/dumper"
+require "compath/path_sorter"
+require "compath/config_loader"
+require "compath/version"

data/lib/compath/cli.rb

@@ -0,0 +1,18 @@
+module Compath
+  class CLI
+    def self.run
+      finder = Compath::Finder.new
+      paths = Compath::PathSorter.sort(finder.paths.keys)
+
+      config = Compath::ConfigLoader.load(File.read('.compath.yml'))
+
+      guides = paths.map {|path| Compath::Guide.new(path) }
+      guide_book = Compath::GuideBook.new(guides)
+      guide_book.merge(config)
+
+      yaml = guide_book.publish_yaml
+
+      puts yaml
+    end
+  end
+end

data/lib/compath/config_loader.rb

@@ -0,0 +1,17 @@
+module Compath
+  module ConfigLoader
+    module_function
+    def load(config)
+      conf = YAML.load(config)
+
+      guides = conf.map do |guide_hash|
+        path = guide_hash.keys.first
+        options = guide_hash.values.first
+        options = options.each_with_object({}) do |(key, value), hash|
+          hash[key.to_sym] = value
+        end
+        Guide.new(path, **options)
+      end
+    end
+  end
+end

data/lib/compath/dumper.rb

@@ -0,0 +1,23 @@
+module Compath
+  class Dumper
+    def initialize(paths)
+      @paths = paths.each_with_object({}) do |path, hash|
+        hash[path] = Guide.new(path)
+      end
+    end
+
+    def dump
+      @paths.values.map do |path|
+        scan_target = true
+        scan_target = path.ancestors.all?(&:scan_children)
+        next unless scan_target
+        path.to_object
+      end.compact
+    end
+    alias_method :dump_hash, :dump
+
+    def dump_yaml
+      YAML.dump(dump_hash)
+    end
+  end
+end

data/lib/compath/finder.rb

@@ -0,0 +1,18 @@
+module Compath
+  class Finder
+    def files
+      @files ||= begin
+                   files = `git ls-files -z`.split("\x0")
+                   files.map {|file| Pathname.new(file) }
+                 end
+    end
+
+    def paths
+      files.each_with_object({}) do |file, hash|
+        file.descend do |pathname|
+          hash[pathname.to_path] = true
+        end
+      end
+    end
+  end
+end

data/lib/compath/guide.rb

@@ -0,0 +1,56 @@
+module Compath
+  class Guide
+    extend Forwardable
+
+    def_delegators :@pathname, :directory?, :executable?, :to_path
+    attr_reader :pathname, :scan_children
+
+    def initialize(path, scan: true, desc: nil)
+      # claenpath is for dirty configurated guide
+      @pathname = Pathname.new(path).cleanpath
+      @scan_children = scan
+      @description = desc
+    end
+
+    def children
+      pathname.children.map do |child|
+        self.class.new(child.to_path)
+      end
+    end
+
+    def ancestors
+      ancestors = []
+      pathname.ascend do |path|
+        next if path == pathname
+        ancestors << self.class.new(path.to_path)
+      end
+      ancestors
+    end
+
+    def to_object
+      scan_or_not = if !directory? || @scan_children
+                      {}
+                    else
+                      {
+                        'scan' => false
+                      }
+                    end
+
+      object = {
+                 object_key => {
+                   'desc' => @description
+                 }.merge(scan_or_not)
+               }
+
+      object
+    end
+
+    def object_key
+      if directory?
+        pathname.to_s + '/'
+      else
+        pathname.to_s
+      end
+    end
+  end
+end

data/lib/compath/guide_book.rb

@@ -0,0 +1,38 @@
+module Compath
+  class GuideBook
+    attr_reader :paths
+    def initialize(guides)
+      @index = guides.each_with_object({}) do |guide, hash|
+        hash[guide.to_path] = guide
+      end
+    end
+
+    def guides
+      @index.values
+    end
+
+    def merge(new_guides)
+      new_guides.each do |guide|
+        puts guide.to_path
+        if @index.key?(guide.to_path)
+          @index[guide.to_path] = guide
+        end
+      end
+    end
+
+    def publish
+      guides.map do |guide|
+        scan_children = true
+        scan_children = guide.ancestors.all? do |ancestor|
+          @index[ancestor.to_path].scan_children
+        end
+        next unless scan_children
+        guide.to_object
+      end.compact
+    end
+
+    def publish_yaml
+      YAML.dump(publish)
+    end
+  end
+end

data/lib/compath/path_sorter.rb

@@ -0,0 +1,23 @@
+module Compath
+  # TODO: Remove Pathname
+  module PathSorter
+    module_function
+
+    def sort(paths)
+      sorted_pathnames.map(&:to_path) & paths
+    end
+
+    def sorted_pathnames(path = '.')
+      collected = []
+      current = Pathname.new(path)
+      if current.directory?
+        collected << current
+        collected += current.children.flat_map { |child| sorted_pathnames(child) }
+      else
+        collected << current
+      end
+
+      collected
+    end
+  end
+end

data/lib/compath/version.rb

@@ -0,0 +1,3 @@
+module Compath
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: compath
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- meganemura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 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'
+description: Compath generates a guide of directory structure in the project
+email:
+- meganemura@users.noreply.github.com
+executables:
+- compath
+extensions: []
+extra_rdoc_files: []
+files:
+- ".compath.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- compath.gemspec
+- exe/compath
+- lib/compath.rb
+- lib/compath/cli.rb
+- lib/compath/config_loader.rb
+- lib/compath/dumper.rb
+- lib/compath/finder.rb
+- lib/compath/guide.rb
+- lib/compath/guide_book.rb
+- lib/compath/path_sorter.rb
+- lib/compath/version.rb
+homepage: https://github.com/meganemura/compath
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Compath generates a guide of directory structure in the project
+test_files: []