everything-core 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cac2a61a41333091daa8d890ed1f76d5489fd926eeb40d49bcb94166a67fbb1
-  data.tar.gz: a9706095474bbf816907ee161cedf94d2c11721d016074470a24c365b7f9cc1b
+  metadata.gz: bae9b9a7c10aa14d43dbf312ba25c0a2dec325000f8bc75bda0150aefc00fbd1
+  data.tar.gz: d9ac581faf22de423daf8fc3cd990f9b81bad9679e03439e701cdaa3d4515f67
 SHA512:
-  metadata.gz: 33d436558aa5bf1b4228f4f0bcb544ece781f6fb21bdf80329ecaccc13fc621f4df234fdbacb9517bf7183c7d2756790ec73cce29c63037480ddf22af5fec2fa
-  data.tar.gz: 51ac31b045ff9db5cfce7f50d140877790d86f4d067e6f1b7348e6822e922052d989ad94281a4afb5767f33eda3dc97d98b7194a0872d302a0773bde1fb38bf2
+  metadata.gz: 5bdd8c94ac5d55fcbdc6b075a4e22a8343f67e8e55ab2391d92161896e413387612ba855c0287091129abdd2b39d75224dcef4512b6345d5a75640bd2993fcf8
+  data.tar.gz: 2bef7eba4b4ce2498df87d852c675de6b4a532a8ac34c4f2546721ba917a501169311068a893a403d15471ae99c4781d649db549794c75842e848984aa238fcf

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+cache: bundler
 rvm:
   - 2.7.1
 before_install: gem install bundler

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.0.13
+
+- **BREAKING CHANGE**: Make Everything.path an instance of Pathname
+- Add #absolute_dir, #absolute_path, #dir, #file_name, #path to Everything::Piece
+- Memoize Everything::Piece#name
+- Add #absolute_dir, #absolute_path, #dir, #path to Everything::Piece::Content
+- Add #absolute_dir, #absolute_path, #dir, #path to Everything::Piece::Metadata
+- Deprecate #file_path on Everything::Piece::Content and Everything::Piece::Metadata
+- Use Pathname convenience methods when working with files and paths internally
+
 ## 0.0.12
 
 - Add an Everything logger

data/README.md

@@ -75,7 +75,7 @@ and content.
 ```ruby
 require 'everything'
 
-piece_path = File.join(Everything.path, 'your-piece-here')
+piece_path = Everything.path.join('your-piece-here')
 piece      = Everything::Piece.new(piece_path)
 
 piece.name          # => 'your-piece-here'

data/everything-core.gemspec

@@ -30,5 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '>= 13.0.1'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'timecop', '~> 0.9'
+  spec.add_development_dependency 'fakefs', '~> 1.2.2'
 end
 

data/lib/everything.rb

@@ -1,6 +1,7 @@
 require 'dotenv'
 Dotenv.load
 
+require 'pathname'
 require 'fastenv'
 require 'everything/version'
 require 'everything/logger'
@@ -8,7 +9,7 @@ require 'everything/piece'
 
 module Everything
   def self.path
-    Fastenv.everything_path
+    Pathname.new(Fastenv.everything_path)
   end
 end
 

data/lib/everything/piece.rb

@@ -14,7 +14,7 @@ module Everything
       @content ||= Content.new(full_path)
     end
 
-    def_delegators :content, :body, :raw_markdown, :raw_markdown=, :title
+    def_delegators :content, :absolute_dir, :absolute_path, :body, :dir, :file_name, :path, :raw_markdown, :raw_markdown=, :title
 
     def metadata
       @metadata ||= Metadata.new(full_path)
@@ -27,7 +27,7 @@ module Everything
     def_delegators :metadata, :raw_yaml, :raw_yaml=
 
     def name
-      File.basename(full_path)
+      @name ||= File.basename(full_path)
     end
 
     def save

data/lib/everything/piece/content.rb

@@ -7,11 +7,26 @@ module Everything
         @piece_path = piece_path
       end
 
+      def absolute_dir
+        @absolute_dir ||= Everything.path.join(dir)
+      end
+
+      def absolute_path
+        @absolute_path ||= absolute_dir.join(file_name)
+      end
+
+      def dir
+        @dir ||= calculated_dir
+      end
+
       def file_name
         'index.md'
       end
 
       def file_path
+        # TODO: Could try a deprecation approach like http://seejohncode.com/2012/01/09/deprecating-methods-in-ruby/
+        deprecation_message = "Piece Content's #file_path is deprecated and will be removed soon. Use #absolute_path instead."
+        warn deprecation_message
         @file_path ||= File.join(piece_path, file_name)
       end
 
@@ -23,8 +38,12 @@ module Everything
         partitioned_text.last
       end
 
+      def path
+        @path ||= dir.join(file_name)
+      end
+
       def raw_markdown
-        @raw_markdown ||= File.read(file_path)
+        @raw_markdown ||= absolute_path.read
       end
 
       def raw_markdown=(value)
@@ -34,7 +53,7 @@ module Everything
       def save
         FileUtils.mkdir_p(piece_path)
 
-        File.write(file_path, @raw_markdown)
+        absolute_path.write(@raw_markdown)
       end
 
     private
@@ -43,6 +62,12 @@ module Everything
       def partitioned_text
         @partitioned_text ||= raw_markdown.partition("\n\n")
       end
+
+      def calculated_dir
+        full_pathname = Pathname.new(piece_path)
+        _relative_pathname = full_pathname.relative_path_from(Everything.path)
+      end
     end
   end
 end
+

data/lib/everything/piece/metadata.rb

@@ -15,12 +15,31 @@ module Everything
         @piece_path = piece_path
       end
 
+      def absolute_dir
+        @absolute_dir ||= Everything.path.join(dir)
+      end
+
+      def absolute_path
+        @absolute_path ||= absolute_dir.join(file_name)
+      end
+
+      def dir
+        @dir ||= calculated_dir
+      end
+
       def file_path
+        # TODO: Could try a deprecation approach like http://seejohncode.com/2012/01/09/deprecating-methods-in-ruby/
+        deprecation_message = "Piece Metadata's #file_path is deprecated and will be removed soon. Use #absolute_path instead."
+        warn deprecation_message
         @file_path ||= File.join(piece_path, file_name)
       end
 
+      def path
+        @path ||= dir.join(file_name)
+      end
+
       def raw_yaml
-        @raw_yaml ||= YAML.load_file(file_path)
+        @raw_yaml ||= YAML.load_file(absolute_path)
       end
 
       def raw_yaml=(value)
@@ -30,7 +49,7 @@ module Everything
       def save
         FileUtils.mkdir_p(piece_path)
 
-        File.write(file_path, @raw_yaml)
+        absolute_path.write(@raw_yaml)
       end
 
       def_delegators :raw_yaml, :[]
@@ -41,6 +60,11 @@ module Everything
       def file_name
         'index.yaml'
       end
+
+      def calculated_dir
+        full_pathname = Pathname.new(piece_path)
+        _relative_pathname = full_pathname.relative_path_from(Everything.path)
+      end
     end
   end
 end

data/lib/everything/version.rb

@@ -1,3 +1,3 @@
 module Everything
-  VERSION = '0.0.12'
+  VERSION = '0.0.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everything-core
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Kyle Tolle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 description: Gives you access to pieces within your everything repo.
 email:
 - kyle@nullsix.com