pathtree 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d8abe169d75eec0e468f2632575fea2087681a73a60792f58bdb13519b71633
-  data.tar.gz: 82d71231c2b80f0ec8ebaea69677b2d12c6ee2ebfcb0aec83accf6c67255b1df
+  metadata.gz: 2fa0b4b00d649556ade2438672e8f579096425641c87dc12904c0b1e83896f4c
+  data.tar.gz: a20dc412a32816c46688ae0ee426f1ee19d954290d3def13f64d50099a737956
 SHA512:
-  metadata.gz: 30599d8e1979cfa9f5589985da12e7711ddbffe60e7407f877f3b9dec78185bff29876951791f8525d0531d9a94d17b47a86a5ed988ea41608fb7c60e7b4d18a
-  data.tar.gz: 128c8141f301f80b321af22171203c7bad4c666a03e51b8a477445f6a37ec177cc890026acdf069afdca346f37745341c844085cd9b19a59c81ed2b69edf0ee9
+  metadata.gz: 19b2cf1822c9380fbd6161ee50b3fd57990811d93331ddd22530982907654b2e6dee118715da9ccd76c5921afd01249a7fa1357b30886cab3f4ce45430f2f53f
+  data.tar.gz: 01bda1e63a6dcc19803a10857cb581d7457a87329e1c2592cfb355a6f5a4e235e301eea171f22a4fd613afcdaff69a6369433824c5e4595160ceee3660d6fd94

data/CHANGELOG.md

@@ -7,9 +7,20 @@ 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
+### 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
@@ -22,20 +33,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * `Pathtree::StringRefinements#split_extension`
 * `Pathtree::ObjectRefinements#file_path` and `Pathtree::ObjectRefinements#directory_path`
 
-### Removed
+### 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
+### Changed in 0.3.0
 
 * Visibility of `Pathtree::Dsl#read` to private
 
 ## 0.2.0 - 2021-11-20
 
-### Changed
+### Changed in 0.2.0
 
 * `Pathtree` inherits `Pathname`
 
@@ -55,14 +66,14 @@ Pathtree::Dsl.read('paths.rb').aaa.then { path(_1) } # $PWD/aaa
 Pathtree::Dsl.read('paths.rb').aaa # $PWD/aaa
 ```
 
-### Removed
+### 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

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

@@ -2,6 +2,6 @@
 
 require 'pathname'
 
-class Pathtree < Pathname
-  VERSION = '0.3.0'
+module Pathtree
+  VERSION = '0.4.0'
 end

data/lib/pathtree.rb

@@ -1,102 +1,31 @@
 # frozen_string_literal: true
 
-require 'pathname'
 require_relative 'pathtree/version'
+require_relative 'pathtree/trunk'
 
-class Pathtree < Pathname
-  module StringRefinements
-    refine String do
-      def prefix_dot
-        return self if start_with?('.')
+# Pathname DSL
+module Pathtree
+  class MethodDuplicationError < NameError; end
 
-        ".#{self}"
-      end
-
-      # Split at last underscore `_` and turn last part into file extension
-      #
-      #   "aaa_bbb_ccc".split_extension #=> aaa_bbb.ccc
-      def split_extension
-        sub(/\A[a-z0-9_]*\K_(?=[a-z0-9]+\Z)/, '.')
-      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
 
-  module ObjectRefinements
-    using StringRefinements
-
-    refine Object do
-      # Use Pathtree::StringRefinements#split_extension by default
-      def file_path(name:)
-        path(name: name, proc_for_nil: -> { _1.split_extension })
-      end
-
-      def directory_path(name:)
-        path(name: name, proc_for_nil: -> { _1 })
-      end
-
-      private
-
-      def path(name:, proc_for_nil:) # :nodoc:
-        case self
-        in String
-          self
-        in NilClass
-          proc_for_nil.call(name.to_s)
-        in Proc
-          call(name.to_s)
-        end
-      end
-    end
+  # 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
 
-  class Dsl
-    def self.read(file_path, working_directory: Pathname.pwd)
-      new(working_directory: working_directory)
-        .tap { _1.send(:read, file_path) }
-        .instance_variable_get(:@working_directory)
-    end
-
-    # See also Pathtree::Dsl.read.
-    def initialize(working_directory: Pathname.pwd)
-      @working_directory = Pathtree.new(working_directory)
-    end
-
-    using ObjectRefinements
-
-    def file(name, path = nil)
-      path = path.file_path(name: name)
-
-      # 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
-
-      @working_directory.define_singleton_method(name) { working_directory / path }
-    end
-
-    def directory(name, path = nil, &block)
-      path = path.directory_path(name: name)
-
-      # 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
-
-      @working_directory.define_singleton_method(name) do
-        Dsl.new(working_directory: working_directory)
-           .tap { _1.instance_eval(&block) if block_given? }
-           .instance_variable_get(:@working_directory)
-      end
-    end
-
-    alias dir directory
-
+  class << self
     private
 
-    using StringRefinements
-
-    def read(file_path)
-      instance_eval File.read(file_path)
+    def to_path(value)
+      value = Pathname(value) if value.is_a?(String)
+      Dsl.extend(value, root: value)
     end
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: pathtree
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - gemmaro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-12 00:00:00.000000000 Z
+date: 2022-05-14 00:00:00.000000000 Z
 dependencies: []
-description: Tree structure of Pathname
+description: Pathname DSL
 email:
 - gemmaro.dev@gmail.com
 executables: []
@@ -21,6 +21,8 @@ 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:
@@ -42,8 +44,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Tree structure of Pathname
+summary: Pathname DSL
 test_files: []