everything-core 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 496abd62729fa5456b73ba7325a331e40ce6ba32
-  data.tar.gz: ba227e14bc31850f0e714c44121cf1a44d82b3f6
+  metadata.gz: 6ec10f405f9e3b3bbaf85dba2c298004fb2a0cf8
+  data.tar.gz: 603c8bf8d70377ab4e613e1489d26e5fbbb35212
 SHA512:
-  metadata.gz: 2c5a438383b336fceece599184d79f2a3fe4d131ff8ef9d50397dd92710c6d86856c94e03d5263e8e975e608cbb1330c80e768565a510d17fb213587e509155f
-  data.tar.gz: 7b05054d7200b1f55e9d1d2562647113774a5a4ee1bd83efd03801b6bf4495fe89ca919a9121a7fe3e7e2e9cc5e9eaa05e068768f70a3089c3b6192bd9f33d3d
+  metadata.gz: 7c2420306c0192aae6105c9298954a7ed355e0cfc792ecccf5bd60a016e34ac5164df2ccf7a96e734c1909f9c8e964410405abfbe7402b102ff5f81845559ccb
+  data.tar.gz: 06b03c77b76c83c908c728abe97ac13478528883cbe6ea8f3ab1431955b99ab1c972342623d06d4643276c280072a060ae9a621c77de5a0a24c464c71e501177

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.0.9
+
+- Make Content#file_name a public method
+
 ## 0.0.8
 
 - Require modules which had been used but not explicitly required

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,7 +72,7 @@ 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')
@@ -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

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler", "bundler")

data/bin/console

@@ -1,14 +1,16 @@
 #!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'console' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
 
-require "bundler/setup"
-require "everything"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require "rubygems"
+require "bundler/setup"
 
-require "irb"
-IRB.start
+load Gem.bin_path("everything-core", "console")

data/bin/dotenv

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'dotenv' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("dotenv", "dotenv")

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -1,8 +1,16 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'setup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
 
-bundle install
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-# Do any other automated setup that you need to do here
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("everything-core", "setup")

data/everything-core.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   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'

data/lib/everything/piece/content.rb

@@ -7,6 +7,10 @@ module Everything
         @piece_path = piece_path
       end
 
+      def file_name
+        'index.md'
+      end
+
       def file_path
         @file_path ||= File.join(piece_path, file_name)
       end
@@ -36,10 +40,6 @@ module Everything
     private
       attr_reader :piece_path
 
-      def file_name
-        'index.md'
-      end
-
       def partitioned_text
         @partitioned_text ||= raw_markdown.partition("\n\n")
       end

data/lib/everything/piece/metadata.rb

@@ -6,6 +6,11 @@ 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

data/lib/everything/version.rb

@@ -1,3 +1,3 @@
 module Everything
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/spec/everything/piece/content_spec.rb

@@ -27,6 +27,18 @@ MD
     described_class.new(tmp_piece_path)
   end
 
+  describe '#file_name' do
+    include_context 'with tmp piece on disk'
+
+    let(:expected_file_name) do
+      'index.md'
+    end
+
+    it 'is the markdown file according to everything convention' do
+      expect(content.file_name).to eq(expected_file_name)
+    end
+  end
+
   describe '#file_path' do
     include_context 'with tmp piece on disk'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everything-core
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Kyle Tolle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +84,13 @@ description: Gives you access to pieces within your everything repo.
 email:
 - kyle@nullsix.com
 executables:
+- bundler
 - console
+- dotenv
+- htmldiff
+- ldiff
+- rake
+- rspec
 - setup
 extensions: []
 extra_rdoc_files: []
@@ -98,7 +104,13 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/bundler
 - bin/console
+- bin/dotenv
+- bin/htmldiff
+- bin/ldiff
+- bin/rake
+- bin/rspec
 - bin/setup
 - everything-core.gemspec
 - lib/everything.rb
@@ -132,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Library for working with your `everything` repository.