everything-core 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8aca9092f34828f75505f2d3c36a03bd20845114
-  data.tar.gz: 7dfbd73bc6f5a5009f5abe169359067bca9b0b29
+  metadata.gz: 496abd62729fa5456b73ba7325a331e40ce6ba32
+  data.tar.gz: ba227e14bc31850f0e714c44121cf1a44d82b3f6
 SHA512:
-  metadata.gz: f7d1b41ee152d93d758cfa0cbe2b082cb07c11d39dfcdc45063bf7f756d669d95d31d8678b5e4c14a13408779f9dfc91ee9aa8f85854c84da6e03d8ea9738cb3
-  data.tar.gz: 64dd8236c33db109b282af925f74b60acb51045ff30cdf3a80b2c501c489b7a36212c812ee65fbcd2d12b3ce5aa143131505046158fffdedc98fb50bcb07ca5d
+  metadata.gz: 2c5a438383b336fceece599184d79f2a3fe4d131ff8ef9d50397dd92710c6d86856c94e03d5263e8e975e608cbb1330c80e768565a510d17fb213587e509155f
+  data.tar.gz: 7b05054d7200b1f55e9d1d2562647113774a5a4ee1bd83efd03801b6bf4495fe89ca919a9121a7fe3e7e2e9cc5e9eaa05e068768f70a3089c3b6192bd9f33d3d

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.0.8
+
+- Require modules which had been used but not explicitly required
+- Add #raw_markdown=, #save to Content
+- Add #raw_yaml=, #save to Metadata
+- Add #raw_markdown=, #raw_yaml, #raw_yaml=, #save to Piece
+
 ## 0.0.7
 
 - Add a piece#name to return the name from the piece's path

data/README.md

@@ -67,6 +67,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
+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/lib/everything/piece/content.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module Everything
   class Piece
     class Content
@@ -21,6 +23,16 @@ module Everything
         @raw_markdown ||= File.read(file_path)
       end
 
+      def raw_markdown=(value)
+        @raw_markdown = value
+      end
+
+      def save
+        FileUtils.mkdir_p(piece_path)
+
+        File.write(file_path, @raw_markdown)
+      end
+
     private
       attr_reader :piece_path
 

data/lib/everything/piece/metadata.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require 'yaml'
 
 module Everything
@@ -17,6 +18,16 @@ module Everything
         @raw_yaml ||= YAML.load_file(file_path)
       end
 
+      def raw_yaml=(value)
+        @raw_yaml = value
+      end
+
+      def save
+        FileUtils.mkdir_p(piece_path)
+
+        File.write(file_path, @raw_yaml)
+      end
+
       def_delegators :raw_yaml, :[]
 
     private

data/lib/everything/piece.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 module Everything
   class Piece
     extend Forwardable
@@ -12,7 +14,7 @@ module Everything
       @content ||= Content.new(full_path)
     end
 
-    def_delegators :content, :body, :raw_markdown, :title
+    def_delegators :content, :body, :raw_markdown, :raw_markdown=, :title
 
     def metadata
       @metadata ||= Metadata.new(full_path)
@@ -22,9 +24,16 @@ module Everything
       metadata['public']
     end
 
+    def_delegators :metadata, :raw_yaml, :raw_yaml=
+
     def name
       File.basename(full_path)
     end
+
+    def save
+      content.save
+      metadata.save
+    end
   end
 end
 

data/lib/everything/version.rb

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

data/spec/everything/piece/content_spec.rb

@@ -86,12 +86,105 @@ MD
         .to receive(:read)
         .and_call_original
 
-      content.raw_markdown
-      content.raw_markdown
+      2.times { content.raw_markdown }
 
       expect(File)
         .to have_received(:read)
         .exactly(:once)
     end
   end
+
+  describe '#raw_markdown=' do
+    include_context 'with tmp piece on disk'
+
+    let(:new_raw_markdown) do
+      <<MD
+# New Markdown
+
+This is a completely new bit of markdown.
+MD
+    end
+
+    it 'sets the raw_markdown value' do
+      content.raw_markdown = new_raw_markdown
+
+      expect(content.raw_markdown).to eq(new_raw_markdown)
+    end
+  end
+
+  describe '#save' do
+    let(:tmp_dir) do
+      Dir.tmpdir
+    end
+
+    let(:tmp_piece_path) do
+      File.join(tmp_dir, 'a-test-piece')
+    end
+
+    before do
+      content.raw_markdown = "# Ship Shape"
+    end
+
+    after do
+      FileUtils.remove_entry(tmp_piece_path)
+    end
+
+    context 'when the piece directory does not exist' do
+      it 'creates the folder' do
+        expect(Dir.exist?(tmp_piece_path)).to eq(false)
+
+        content.save
+
+        expect(Dir.exist?(tmp_piece_path)).to eq(true)
+      end
+
+      it 'creates the content markdown file' do
+        expect(File.exist?(content.file_path)).to eq(false)
+
+        content.save
+
+        expect(File.exist?(content.file_path)).to eq(true)
+      end
+
+      it 'writes the markdown to the file' do
+        content.save
+
+        expect(File.read(content.file_path)).to eq('# Ship Shape')
+      end
+    end
+
+    context 'when the piece directory exists' do
+      before do
+        FileUtils.mkdir_p(tmp_piece_path)
+      end
+
+      context 'when the content file does not exist' do
+        it 'creates the content markdown file' do
+          expect(File.exist?(content.file_path)).to eq(false)
+
+          content.save
+
+          expect(File.exist?(content.file_path)).to eq(true)
+        end
+
+        it 'writes the markdown to the file' do
+          content.save
+
+          expect(File.read(content.file_path)).to eq('# Ship Shape')
+        end
+      end
+
+      context 'when the content file already exists' do
+        before do
+          File.write(content.file_path, '# Rolly Polly')
+        end
+
+        it 'overwrites the file with the correct markdown' do
+          content.save
+
+          expect(File.read(content.file_path)).to eq('# Ship Shape')
+        end
+      end
+    end
+  end
 end

data/spec/everything/piece/metadata_spec.rb

@@ -89,4 +89,110 @@ YAML
         .exactly(:once)
     end
   end
+
+  describe '#raw_yaml=' do
+    include_context 'with tmp piece on disk'
+
+    let(:new_raw_yaml) do
+      <<YAML
+---
+public: true
+other: okay
+YAML
+    end
+
+    it 'sets the raw_yaml value' do
+      metadata.raw_yaml = new_raw_yaml
+
+      expect(metadata.raw_yaml).to eq(new_raw_yaml)
+    end
+  end
+
+  describe '#save' do
+    let(:tmp_dir) do
+      Dir.tmpdir
+    end
+
+    let(:tmp_piece_path) do
+      File.join(tmp_dir, 'fake-piece-here')
+    end
+
+    before do
+      metadata.raw_yaml = <<YAML
+---
+favorite_color: blue
+YAML
+    end
+
+    after do
+      FileUtils.remove_entry(tmp_piece_path)
+    end
+
+    context 'when the piece directory does not exist' do
+      it 'creates the folder' do
+        expect(Dir.exist?(tmp_piece_path)).to eq(false)
+
+        metadata.save
+
+        expect(Dir.exist?(tmp_piece_path)).to eq(true)
+      end
+
+      it 'creates the metadata yaml file' do
+        expect(File.exist?(metadata.file_path)).to eq(false)
+
+        metadata.save
+
+        expect(File.exist?(metadata.file_path)).to eq(true)
+      end
+
+      it 'writes the yaml to the file' do
+        metadata.save
+
+        expect(File.read(metadata.file_path)).to eq(<<YAML)
+---
+favorite_color: blue
+YAML
+      end
+    end
+
+    context 'when the piece directory exists' do
+      before do
+        FileUtils.mkdir_p(tmp_piece_path)
+      end
+
+      context 'when the metadata file does not exist' do
+        it 'creates the metadata yaml file' do
+          expect(File.exist?(metadata.file_path)).to eq(false)
+
+          metadata.save
+
+          expect(File.exist?(metadata.file_path)).to eq(true)
+        end
+
+        it 'writes the yaml to the file' do
+          metadata.save
+
+          expect(File.read(metadata.file_path)).to eq(<<YAML)
+---
+favorite_color: blue
+YAML
+        end
+      end
+
+      context 'when the metadata file already exists' do
+        before do
+          File.write(metadata.file_path, "---\nwho: knows")
+        end
+
+        it 'overwrites the file with the correct yaml' do
+          metadata.save
+
+          expect(File.read(metadata.file_path)).to eq(<<YAML)
+---
+favorite_color: blue
+YAML
+        end
+      end
+    end
+  end
 end

data/spec/everything/piece_spec.rb

@@ -5,6 +5,7 @@ describe Everything::Piece do
   let(:piece) do
     described_class.new(given_full_path)
   end
+
   shared_context 'with content double' do
     let(:content_double) do
       instance_double(Everything::Piece::Content)
@@ -17,6 +18,18 @@ describe Everything::Piece do
     end
   end
 
+  shared_context 'with metadata double' do
+    let(:metadata_double) do
+      instance_double(Everything::Piece::Metadata)
+    end
+
+    before do
+      allow(Everything::Piece::Metadata)
+        .to receive(:new)
+        .and_return(metadata_double)
+    end
+  end
+
   describe '#body' do
     include_context 'with content double'
 
@@ -104,6 +117,20 @@ describe Everything::Piece do
     end
   end
 
+  describe '#raw_markdown=' do
+    include_context 'with content double'
+
+    it 'delegates to the content' do
+      allow(content_double).to receive(:raw_markdown=)
+
+      piece.raw_markdown=("# Test markdown")
+
+      expect(content_double)
+        .to have_received(:raw_markdown=)
+        .with("# Test markdown")
+    end
+  end
+
   describe '#title' do
     include_context 'with content double'
 
@@ -115,4 +142,54 @@ describe Everything::Piece do
       expect(content_double).to have_received(:title)
     end
   end
+
+  describe '#raw_yaml' do
+    include_context 'with metadata double'
+
+    it 'delegates to the metadata' do
+      allow(metadata_double).to receive(:raw_yaml)
+
+      piece.raw_yaml
+
+      expect(metadata_double).to have_received(:raw_yaml)
+    end
+  end
+
+  describe '#raw_yaml=' do
+    include_context 'with metadata double'
+
+    it 'delegates to the metadata' do
+      allow(metadata_double).to receive(:raw_yaml=)
+
+      piece.raw_yaml=("---\nanything: works")
+
+      expect(metadata_double)
+        .to have_received(:raw_yaml=)
+        .with("---\nanything: works")
+    end
+  end
+
+  describe '#save' do
+    include_context 'with content double'
+    include_context 'with metadata double'
+
+    before do
+      allow(content_double).to receive(:save)
+      allow(metadata_double).to receive(:save)
+    end
+
+    it 'calls save on the content' do
+      piece.save
+
+      expect(content_double)
+        .to have_received(:save)
+    end
+
+    it 'calls save on the metadata' do
+      piece.save
+
+      expect(metadata_double)
+        .to have_received(:save)
+    end
+  end
 end

data/spec/support/pieces.rb

@@ -1,3 +1,6 @@
+require 'tmpdir'
+require 'fileutils'
+
 RSpec.shared_context 'with tmp piece on disk' do
   let!(:tmp_piece_path) do
     Dir.mktmpdir

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everything-core
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Kyle Tolle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Library for working with your `everything` repository.