everything-core 0.0.8 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 496abd62729fa5456b73ba7325a331e40ce6ba32
-  data.tar.gz: ba227e14bc31850f0e714c44121cf1a44d82b3f6
+SHA256:
+  metadata.gz: bae9b9a7c10aa14d43dbf312ba25c0a2dec325000f8bc75bda0150aefc00fbd1
+  data.tar.gz: d9ac581faf22de423daf8fc3cd990f9b81bad9679e03439e701cdaa3d4515f67
 SHA512:
-  metadata.gz: 2c5a438383b336fceece599184d79f2a3fe4d131ff8ef9d50397dd92710c6d86856c94e03d5263e8e975e608cbb1330c80e768565a510d17fb213587e509155f
-  data.tar.gz: 7b05054d7200b1f55e9d1d2562647113774a5a4ee1bd83efd03801b6bf4495fe89ca919a9121a7fe3e7e2e9cc5e9eaa05e068768f70a3089c3b6192bd9f33d3d
+  metadata.gz: 5bdd8c94ac5d55fcbdc6b075a4e22a8343f67e8e55ab2391d92161896e413387612ba855c0287091129abdd2b39d75224dcef4512b6345d5a75640bd2993fcf8
+  data.tar.gz: 2bef7eba4b4ce2498df87d852c675de6b4a532a8ac34c4f2546721ba917a501169311068a893a403d15471ae99c4781d649db549794c75842e848984aa238fcf

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # 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
+- Add a Debug logger
+- Add a Verbose logger
+- Add an Error logger
+- Add a LogIt module to make logging easy
+
+## 0.0.11
+
+- Update changelog for 0.0.10 changes
+- Update travis settings to use ruby 2.7.1 and bundler 2
+
+## 0.0.10
+
+- Upgrade to Bundler v2
+
+## 0.0.9
+
+- Make Content#file_name a public method
+
 ## 0.0.8
 
 - Require modules which had been used but not explicitly required

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
+ruby '2.7.1'
 
 # The gem's dependencies are specified in `everything-core.gemspec`.
 gemspec

data/README.md

@@ -22,7 +22,7 @@ Must define these environment variables:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem install everything-core
+gem 'everything-core', require: 'everything'
 ```
 
 And then execute:
@@ -34,6 +34,24 @@ Or install it yourself as:
     $ gem install everything-core
 
 
+## Requiring
+
+You can require it yourself in your code:
+
+```
+require 'everything'
+```
+
+Or, if you use Bundler and list the gem in your Gemfile, you can require all the
+gems from your Gemfile:
+
+```ruby
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
+```
+
+
 ## Usage
 
 This assumes you have a `EVERYTHING_PATH` environment variable either set in
@@ -42,7 +60,7 @@ your shell or in dotenv's `.env` file.
 For example, let's assume you have the following folder and file under your
 everything path
 
-```
+```ruby
 your-piece-here/index.md
 
 # Your Piece Here
@@ -54,10 +72,10 @@ The rest of the body of your file...
 To use the piece from IRB, you could do the following to get the piece's title
 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'
@@ -67,8 +85,11 @@ piece['categories'] # Returns the value for the `categories` metadata key
 piece.public?       # Convience method to return the value for the boolean `public` metadata key
 piece.content       # Return an instance of the piece's content
 piece.metadata      # Return an instance of the piece's metadata
+```
 
-# You can also edit a piece's content and metadata
+You can also edit a piece's content and metadata
+
+```ruby
 piece.raw_markdown = some_markdown # Sets the raw_markdown on the piece's content
 piece.raw_yaml     = some_yaml     # Sets the raw_yaml on the piece's metadata
 piece.save                         # Save the piece's content and metadata to disk
@@ -81,10 +102,22 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 `rake spec` 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 tags, and push the `.gem` file to
+To install this gem onto your local machine, run `rake install`.
+
+To release a new version,
+- check out a new branch
+- make your code changes
+- update the version number in `lib/everything/version.rb`
+- update the `CHANGELOG.md` with what changed.
+- commit your code changes
+- push new branch to github with `git push -u origin HEAD`
+- create a new PR for this
+- merge in PR to master
+- locally, check out master again
+- git pull
+- create a build with `rake build`
+- run `rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
 

data/bin/console

@@ -11,4 +11,4 @@ require "everything"
 # Pry.start
 
 require "irb"
-IRB.start
+IRB.start(__FILE__)

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/everything-core.gemspec

@@ -1,7 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'everything/version'
+require_relative 'lib/everything/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'everything-core'
@@ -12,17 +9,27 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Gives you access to pieces within your everything repo.}
   spec.homepage      = 'https://github.com/kyletolle/everything-core'
   spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.1")
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency 'dotenv', '~> 2.1'
-  spec.add_runtime_dependency 'fastenv', '= 0.0.2'
+  spec.add_runtime_dependency 'fastenv', '= 0.0.3'
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.5'
-  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  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,13 +1,15 @@
 require 'dotenv'
 Dotenv.load
 
+require 'pathname'
 require 'fastenv'
 require 'everything/version'
+require 'everything/logger'
 require 'everything/piece'
 
 module Everything
   def self.path
-    Fastenv.everything_path
+    Pathname.new(Fastenv.everything_path)
   end
 end
 

data/lib/everything/logger.rb

@@ -0,0 +1,25 @@
+require 'logger'
+require_relative 'logger/base'
+require_relative 'logger/debug'
+require_relative 'logger/error'
+require_relative 'logger/verbose'
+require_relative 'logger/log_it'
+
+module Everything
+  def self.logger
+    @logger ||= default_logger
+  end
+
+  def self.logger=(value)
+    @logger = value
+  end
+
+  def self.default_logger
+    ::Logger.new(
+      $stdout,
+      level: ::Logger::ERROR,
+      progname: self.class.to_s
+    )
+  end
+end
+

data/lib/everything/logger/base.rb

@@ -0,0 +1,17 @@
+module Everything
+  class Logger
+    class Base < ::Logger
+      DATETIME_PROGNAME_MESSAGE_FORMATTER =
+        proc { |severity, datetime, progname, msg|
+          iso8601_time = datetime.utc.iso8601
+          "#{iso8601_time}: #{progname}: #{msg}\n"
+        }
+
+      def initialize(logdev, progname: nil)
+        super
+        self.formatter = DATETIME_PROGNAME_MESSAGE_FORMATTER
+      end
+    end
+  end
+end
+

data/lib/everything/logger/debug.rb

@@ -0,0 +1,7 @@
+module Everything
+  class Logger
+    class Debug < Everything::Logger::Base
+    end
+  end
+end
+

data/lib/everything/logger/error.rb

@@ -0,0 +1,11 @@
+module Everything
+  class Logger
+    class Error < Everything::Logger::Base
+      def initialize(logdev, progname: nil)
+        super
+        self.level = ::Logger::ERROR
+      end
+    end
+  end
+end
+

data/lib/everything/logger/log_it.rb

@@ -0,0 +1,24 @@
+module Everything
+  class Logger
+    module LogIt
+      def debug_it(message)
+        Everything.logger.debug(class_name) { message }
+      end
+
+      def error_it(message)
+        Everything.logger.error(class_name) { message }
+      end
+
+      def info_it(message)
+        Everything.logger.info(class_name) { message }
+      end
+
+    private
+
+      def class_name
+        self.class.to_s
+      end
+    end
+  end
+end
+

data/lib/everything/logger/verbose.rb

@@ -0,0 +1,11 @@
+module Everything
+  class Logger
+    class Verbose < Everything::Logger::Base
+      def initialize(logdev, progname: nil)
+        super
+        self.level = ::Logger::INFO
+      end
+    end
+  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,7 +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
 
@@ -19,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)
@@ -30,19 +53,21 @@ module Everything
       def save
         FileUtils.mkdir_p(piece_path)
 
-        File.write(file_path, @raw_markdown)
+        absolute_path.write(@raw_markdown)
       end
 
     private
       attr_reader :piece_path
 
-      def file_name
-        'index.md'
-      end
-
       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

@@ -6,16 +6,40 @@ module Everything
     class Metadata
       extend Forwardable
 
+      # TODO: Need to add some ways in here to save the metadata file once it's
+      # been edited.
+      # TODO: Also add a #to_s or #inspect methods to render the raw_yaml
+      # TODO: Also add a #[]= here that delegates to raw_yaml as well.
+
       def initialize(piece_path)
         @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)
@@ -25,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, :[]
@@ -36,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