pathtree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de74120e5b4aa9d6861e270420fb1e03fc28a77e9e9ef6f88299e931293511f2
+  data.tar.gz: ec2845821ab2900a60588e4ad1762cae05111ce7b6a7eada70a4a46d889843d9
+SHA512:
+  metadata.gz: ae867e4b72f16495c41f196d5795762cc16992437e3e5ddb86dad1ba99415df5e22143ff390557a7fc19d43af5ed84efbe33f8f9038282816aa7bb40bca5fcc8
+  data.tar.gz: e623ba3f2e117245979f6d9ebe3a2fbc4866bc8aef4100afb4ba90d25c60c0e35b35a8468d2d8f6e09621d8716528fc7127691f393ab58530ee34102531bcdf1

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## 0.1.0 - 2021-11-13
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 gemmaro
+
+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,41 @@
+# Pathtree
+
+Tree structure of Pathname
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pathtree'
+```
+
+And then execute:
+
+```shell-session
+bundle install
+```
+
+Or install it yourself as:
+
+```shell-session
+gem install pathtree
+```
+
+## Usage
+
+See tests.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at <https://gitlab.com/gemmaro/pathtree>.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/pathtree/version.rb

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

data/lib/pathtree.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require_relative 'pathtree/version'
+
+class Pathtree
+  module SymbolRefinements
+    refine Symbol do
+      # +type+ option can be one of the following:
+      #
+      # +:directory+:: +:directory+ simply converts to +String+.
+      # +:file+:: +:file+ converts to +String+, and turn +aaa_bbb_ccc+ into +aaa_bbb.ccc+ for example.
+      def path(type: :directory)
+        case type
+        in :directory
+          to_s
+        in :file
+          to_s.sub(/\A[a-z0-9_]*\K_(?=[a-z0-9]+\Z)/, '.')
+        end
+      end
+    end
+  end
+
+  class Dsl
+    using SymbolRefinements
+
+    attr_reader :tree
+
+    def self.read(file_path, working_directory: Pathname.pwd)
+      new(working_directory: working_directory).tap { _1.read(file_path) }.tree
+    end
+
+    # See also Pathtree::Dsl.read.
+    def initialize(working_directory: Pathname.pwd)
+      @tree = Pathtree.new
+      @working_directory = Pathname(working_directory)
+    end
+
+    def read(file_path)
+      File.read(file_path).then { instance_eval(_1) }
+    end
+
+    def file(name, path = name.path(type: :file))
+      # NOTE: Temporal variable is needed
+      # since define_singleton_method's block is evaluated using instance_eval
+      # which is same as define_method.
+      working_directory = @working_directory
+
+      @tree.define_singleton_method(name) { working_directory / path }
+    end
+
+    def directory(name, path = name.path, &block)
+      working_directory = @working_directory / path
+
+      @tree.define_singleton_method(name) do
+        Dsl.new(working_directory: working_directory)
+           .tap do |d|
+             d.tree.instance_variable_set('@path', working_directory)
+             d.instance_eval(&block) if block_given?
+           end.tree
+      end
+    end
+  end
+
+  module KernelRefinements
+    refine Kernel do
+      def path(tree)
+        tree.instance_variable_get('@path')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: pathtree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- gemmaro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pathname
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.0
+description: Tree structure of Pathname
+email:
+- gemmaro.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/pathtree.rb
+- lib/pathtree/version.rb
+homepage: https://gitlab.com/gemmaro/pathtree
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Tree structure of Pathname
+test_files: []