pathtree 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13b52803c5a409fd368d095edb856e29a3a54c6c7e177df66e4410473ee3f776
-  data.tar.gz: 4ee4258ce192ae3d6ff2f8b943f1d76bc886ce7a2fdbaf851aa549c74d6050ac
+  metadata.gz: 2fa0b4b00d649556ade2438672e8f579096425641c87dc12904c0b1e83896f4c
+  data.tar.gz: a20dc412a32816c46688ae0ee426f1ee19d954290d3def13f64d50099a737956
 SHA512:
-  metadata.gz: f615213773979b011228246740045d274021ca3c453466403cb3c90a44795d0f589f2f4ac5fad0dc1938ee19fb72d089217739fea2061ee7b9d81dc583cc8a64
-  data.tar.gz: 476c327f6704ec2a80ef6abc2eb98f079b6f82aba2cf40f5299e7a7a37163e44dec6baa6046824dc71623f0dab9dd30f8a88b58f7817003e3ed4a9105bbc6c09
+  metadata.gz: 19b2cf1822c9380fbd6161ee50b3fd57990811d93331ddd22530982907654b2e6dee118715da9ccd76c5921afd01249a7fa1357b30886cab3f4ce45430f2f53f
+  data.tar.gz: 01bda1e63a6dcc19803a10857cb581d7457a87329e1c2592cfb355a6f5a4e235e301eea171f22a4fd613afcdaff69a6369433824c5e4595160ceee3660d6fd94

data/CHANGELOG.md

@@ -7,9 +7,73 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.4.0 - 2022-05-14
+
+### Changed in 0.4.0
+
+* Moved `Pathtree::Dsl.read` and `Pathtree::Dsl.load` to `Pathtree.read` and `Pathree.load`.
+* If root path is not given, `Pathtree::Trunk` is used, rather than `Pathname.pwd`.
+
+### Removed in 0.4.0
+
+* Refinements for `String`, `Pathname`, and `Object`
+
+## 0.3.0 - 2021-12-12
+
+### Added in 0.3.0
+
+* GitLab CI which checks tests with Minitest and lint rules with RuboCop
+* Enable to pass `Proc` object to `path` argument
+  of `Pathtree::Dsl#file` and `Pathtree::Dsl#directory`.
+
+  ```ruby
+  file :main_idr, -> { _1.capitalize } # Main.idr
+  ```
+
+* `Pathtree::StringRefinements#split_extension`
+* `Pathtree::ObjectRefinements#file_path` and `Pathtree::ObjectRefinements#directory_path`
+
+### Removed in 0.3.0
+
+* `Pathtree::SymbolRefinements`
+  * Move to `Pathtree::StringRefinements#split_extension`
+* `dot` option for `Pathtree::Dsl#file` and `Pathtree::Dsl#directory`
+  * Use `Proc` for path instead
+
+### Changed in 0.3.0
+
+* Visibility of `Pathtree::Dsl#read` to private
+
+## 0.2.0 - 2021-11-20
+
+### Changed in 0.2.0
+
+* `Pathtree` inherits `Pathname`
+
+`paths.rb`:
+
+```ruby
+dir :aaa
+```
+
+`main.rb`:
+
+```ruby
+# old (not works for now, see removed section)
+Pathtree::Dsl.read('paths.rb').aaa.then { path(_1) } # $PWD/aaa
+
+# new
+Pathtree::Dsl.read('paths.rb').aaa # $PWD/aaa
+```
+
+### Removed in 0.2.0
+
+* `KernelRefinements` since `Pathtree` directory object is now `Pathtree` itself
+* Instance reader attribute `@tree` of `Pathtree::Dsl`
+
 ## 0.1.1 - 2021-11-20
 
-### Added
+### Added in 0.1.1
 
 * `dot` option for `Pathtree::Dsl#file` and `Pathtree::Dsl#directory`.
   If `dot: true`, then path name is prefixed with dot (period) character
@@ -27,4 +91,4 @@ file :rubocop_yml, dot: true # .rubocop.yml
 
 ## 0.1.0 - 2021-11-13
 
-- Initial release
+* Initial release

data/README.md

@@ -1,6 +1,6 @@
 # Pathtree
 
-Tree structure of Pathname
+Pathname DSL
 
 ## Installation
 
@@ -24,13 +24,40 @@ gem install pathtree
 
 ## Usage
 
-See tests.
+`path.rb`:
+
+```ruby
+file :aaa
+
+directory :public do
+  file :bbb
+end
+```
+
+`Rakefile`:
+
+```ruby
+require 'pathtree'
+
+P = Pathtree.read('path.rb')
+
+file P.public.bbb => P.aaa do |t|
+  cp t.source, t.name
+do
+```
 
 ## 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.
+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).
+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
 
@@ -38,4 +65,6 @@ Bug reports and pull requests are welcome on GitLab at <https://gitlab.com/gemma
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License][mit].
+
+[mit]: https://opensource.org/licenses/MIT

data/lib/pathtree/dsl.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Pathtree
+  # DSL for constructing path tree
+  module Dsl
+    attr_reader :names
+
+    # Grows file leaf from the branch;
+    # The path at the point where this method is called
+    # attempts to create an instance method that returns the path with the +name+.
+    #
+    # * If +path+ is +nil+, +name+ is used instead.
+    # * If +path+ is a +Proc+, give +name+ to it.
+    # * Otherwise, +path+ itself is used.
+    def file(name, path = nil)
+      check_name(name)
+      path = normalize(name: name, path: path)
+      path = @root / path if @root
+      @names << name
+      define_singleton_method(name) { path }
+    end
+
+    # Grows directory branch from the branch.
+    # See also Pathtree::Dsl#file method.
+    # This method has optional block, which represents nested file structure.
+    def directory(name, path = nil, &block)
+      check_name(name)
+      path = normalize(name: name, path: path)
+      path = @root / path if @root
+      @names << name
+
+      define_singleton_method(name) do
+        path.tap do |p|
+          Dsl.extend(p, root: path)
+          p.instance_eval(&block) if block
+        end
+      end
+    end
+
+    alias dir directory
+
+    def self.extend(path, root: nil)
+      path.instance_variable_set(:@names, [])
+      path.instance_variable_set(:@root, root)
+      path.extend(Dsl)
+      path
+    end
+
+    private
+
+    def check_name(name)
+      raise MethodDuplicationError, name if respond_to?(name)
+    end
+
+    def normalize(name:, path: nil)
+      if path.nil?
+        Pathname(name.to_s)
+      elsif path.is_a?(String)
+        Pathname(path)
+      elsif path.respond_to?(:call)
+        path.call(name).then { normalize(name: _1) }
+      else
+        path
+      end
+    end
+  end
+end

data/lib/pathtree/trunk.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require_relative 'dsl'
+
+module Pathtree
+  # A trunk of path tree
+  class Trunk
+    include Dsl
+
+    def initialize
+      @names = []
+      @root = nil
+    end
+  end
+end

data/lib/pathtree/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
-class Pathtree
-  VERSION = '0.1.1'
+require 'pathname'
+
+module Pathtree
+  VERSION = '0.4.0'
 end

data/lib/pathtree.rb

@@ -1,91 +1,31 @@
 # frozen_string_literal: true
 
-require 'pathname'
 require_relative 'pathtree/version'
+require_relative 'pathtree/trunk'
 
-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
-
-  module StringRefinements
-    refine String do
-      def prefix_dot
-        return self if start_with?('.')
+# Pathname DSL
+module Pathtree
+  class MethodDuplicationError < NameError; end
 
-        ".#{self}"
-      end
-    end
+  # Read Pathtree DSL from +path+.
+  # +root+ is base directory for tree.
+  def self.read(path, root: nil)
+    dsl = File.read(path)
+    self.load(dsl, root: root)
   end
 
-  class Dsl
-    using SymbolRefinements
-    using StringRefinements
-
-    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), dot: false)
-      # 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
-
-      path = path.prefix_dot if dot
-
-      @tree.define_singleton_method(name) { working_directory / path }
-    end
-
-    def directory(name, path = name.path, dot: false, &block)
-      path = path.prefix_dot if dot
-
-      # 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 / 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
-
-    alias dir directory
+  # Load Pathtree DSL source.
+  # +root+ is base directory for tree.
+  def self.load(dsl, root: nil)
+    (root ? to_path(root) : Trunk.new).tap { _1.instance_eval(dsl) }
   end
 
-  module KernelRefinements
-    refine Kernel do
-      def path(tree)
-        tree.instance_variable_get('@path')
-      end
+  class << self
+    private
+
+    def to_path(value)
+      value = Pathname(value) if value.is_a?(String)
+      Dsl.extend(value, root: value)
     end
   end
 end

metadata

@@ -1,128 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: pathtree
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - gemmaro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-19 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
+date: 2022-05-14 00:00:00.000000000 Z
+dependencies: []
+description: Pathname DSL
 email:
 - gemmaro.dev@gmail.com
 executables: []
@@ -133,11 +21,14 @@ files:
 - LICENSE.txt
 - README.md
 - lib/pathtree.rb
+- lib/pathtree/dsl.rb
+- lib/pathtree/trunk.rb
 - lib/pathtree/version.rb
 homepage: https://gitlab.com/gemmaro/pathtree
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -153,8 +44,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Tree structure of Pathname
+summary: Pathname DSL
 test_files: []