administrate-field-simple_markdown 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a014bcf99d446dd6839d0f6ca9ec7ff4b627cd86
-  data.tar.gz: 4a0effe0ffddd481fd18ae32e0e6a73c53132e64
+SHA256:
+  metadata.gz: 6d3a701c9d55c3e017033cd492ee81b1498389ae51a8c744b2502016016badc9
+  data.tar.gz: ceead71e4f9cc8e1540720eec50a741313b9089f779e0d33217883e3481cbeb4
 SHA512:
-  metadata.gz: b03a2c0a340b2be1ae26b807df540406cb28feb91742002792724e67cf8a02faf3402f533ac229c557a48f4ab5a176eb944894e8f7646fa7fd4a69767db4cf3b
-  data.tar.gz: 377ab6ceba7303f8daf536c15da44be8c36ddb23eccc15201e25875164907283e35a59a842f3a91581632bef0c1acfd0d3215c243dfb078f38e87b4e6647c331
+  metadata.gz: 050efe13f5c9e1d2c29ee61d2cdde82e98261e1672bce77597428c0626deaf447e6b1571bc6e17ed8d8d392823ea8a9bf3769bfad1787d6240490198cbad3617
+  data.tar.gz: 5dc7dce3ab88f7018570894be90ae5e5baff9d5435f731a9b105e8ea353f4cad61cbe33e08ef51c5fd5cb33ce8ebb2bfe72ce5cd88c2cf6ae9d5ca10a4ec2486

data/.gitignore

@@ -1 +1,2 @@
 *.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+

data/CHANGELOG.md

@@ -1,19 +1,32 @@
 # Changelog
 
+## [v0.1.0](https://github.com/zooppa/administrate-field-simple_markdown/tree/v0.1.0) (2018-01-23)
+
+[Full Changelog](https://github.com/zooppa/administrate-field-simple_markdown/compare/v0.0.4...v0.1.0)
+
+* Require Redcarpet
+* Add RSpec and tests
+* Handle null data
+* Update documentation
+
 ## [v0.0.4](https://github.com/zooppa/administrate-field-simple_markdown/tree/v0.0.4) (2017-04-03)
+
 [Full Changelog](https://github.com/zooppa/administrate-field-simple_markdown/compare/v0.0.3...v0.0.4)
 
 * Bump up Administrate dependency
 
 ## [v0.0.3](https://github.com/zooppa/administrate-field-simple_markdown/tree/v0.0.3) (2017-03-20)
+
 [Full Changelog](https://github.com/zooppa/administrate-field-simple_markdown/compare/v0.0.2...v0.0.3)
 
 * Bump up Administrate dependency
 
 ## [v0.0.2](https://github.com/zooppa/administrate-field-simple_markdown/tree/v0.0.2) (2016-11-22)
+
 [Full Changelog](https://github.com/zooppa/administrate-field-simple_markdown/compare/v0.0.1...v0.0.2)
 
 * Bump up Administrate dependency
 
 ## [v0.0.1](https://github.com/zooppa/administrate-field-simple_markdown/tree/v0.0.1) (2016-11-16)
+
 First release

data/README.md

@@ -11,7 +11,7 @@ A plugin to edit Markdown text in [Administrate] using [SimpleMDE] v1.11.2.
 Add it to your `Gemfile`:
 
 ```ruby
-gem 'administrate-field-simple_markdown', '~> 0.0.4'
+gem 'administrate-field-simple_markdown', '~> 0.1.0'
 ```
 
 Run:
@@ -27,12 +27,11 @@ ATTRIBUTE_TYPES = {
   bar: Field::SimpleMarkdown
 }.freeze
 ```
-The field will figure out the appropriate thousand separator and decimal delimiter for the unit.
 
 ## About
 
-Administrate::Field::SimpleMarkdown is maintained by [z.productions].
+Administrate::Field::SimpleMarkdown is maintained by [Zooppa].
 
-[Administrate]: https://github.com/thoughtbot/administrate
-[SimpleMDE]: https://github.com/NextStepWebs/simplemde-markdown-editor
-[z.productions]: https://www.z.productions/
+[administrate]: https://github.com/thoughtbot/administrate
+[simplemde]: https://github.com/NextStepWebs/simplemde-markdown-editor
+[zooppa]: https://www.zooppa.com/

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/administrate-field-simple_markdown.gemspec

@@ -2,12 +2,12 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name = 'administrate-field-simple_markdown'
-  gem.version = '0.0.4'
+  gem.version = '0.1.0'
   gem.authors = ['Michele Gerarduzzi']
   gem.email = ['michele.gerarduzzi@gmail.com']
   gem.homepage = 'https://github.com/zooppa/administrate-field-simple_markdown'
-  gem.summary = 'A plugin to edit Markdown text in Administrate'
-  gem.description = gem.summary
+  gem.summary = 'Markdown editor for Administrate'
+  gem.description = 'A plugin to handle Markdown text in Administrate'
   gem.license = 'MIT'
 
   gem.require_paths = ['lib']
@@ -15,6 +15,9 @@ Gem::Specification.new do |gem|
   gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
 
   gem.add_runtime_dependency 'administrate', '< 1.0.0'
-  gem.add_runtime_dependency 'rails', '>= 4.2'
+  gem.add_runtime_dependency 'rails', '>= 4.2', '< 6'
   gem.add_runtime_dependency 'redcarpet', '~> 3.3'
+
+  gem.add_development_dependency 'rake', '~> 12.3'
+  gem.add_development_dependency 'rspec', '~> 3.7'
 end

data/lib/administrate/field/simple_markdown.rb

@@ -1,5 +1,7 @@
+require 'rails'
 require 'administrate/field/text'
 require 'administrate/engine'
+require 'redcarpet'
 require 'redcarpet/render_strip'
 
 module Administrate
@@ -10,6 +12,10 @@ module Administrate
         Administrate::Engine.add_stylesheet 'administrate-field-simple_markdown/application'
       end
 
+      def data
+        @data || ''
+      end
+
       def to_html
         markdown(html_renderer).render(data).html_safe
       end

data/spec/lib/administrate/field/simple_markdown_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Administrate::Field::SimpleMarkdown do
+  subject { Administrate::Field::SimpleMarkdown.new(:simple_markdown, data, :show) }
+
+  let(:md) { '**foo** is the new _bar_' }
+  let(:text) { 'foo is the new bar' }
+  let(:html) { '<p><strong>foo</strong> is the new <em>bar</em></p>' }
+
+  describe '#data' do
+    let(:output) { subject.data }
+
+    context 'with nil' do
+      let(:data) { nil }
+
+      it 'returns an empty string' do
+        expect(output).to eq ''
+      end
+    end
+
+    context 'with data' do
+      let(:data) { text }
+
+      it 'returns the data' do
+        expect(output).to eq text
+      end
+    end
+  end
+
+  describe '#to_s' do
+    let(:output) { subject.to_s }
+
+    context 'with nil' do
+      let(:data) { nil }
+
+      it 'returns an empty string' do
+        expect(output).to eq ''
+      end
+    end
+
+    context 'with a string' do
+      let(:data) { text }
+
+      it 'returns the same string' do
+        expect(output).to eq "#{text}\n"
+      end
+    end
+
+    context 'with Markdown' do
+      let(:data) { md }
+
+      it 'strips out the formatting' do
+        expect(output).to eq "#{text}\n"
+      end
+    end
+  end
+
+  describe '#to_html' do
+    let(:output) { subject.to_html }
+
+    context 'with nil' do
+      let(:data) { nil }
+
+      it 'returns an empty string' do
+        expect(output).to eq ''
+      end
+    end
+
+    context 'with a string' do
+      let(:data) { text }
+
+      it 'wraps it in a paragraph' do
+        expect(output).to eq "<p>#{text}</p>\n"
+      end
+    end
+
+    context 'with Markdown' do
+      let(:data) { md }
+
+      it 'converts it to HTML' do
+        expect(output).to eq "#{html}\n"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'administrate/field/simple_markdown'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: administrate-field-simple_markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Michele Gerarduzzi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-03 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate
@@ -31,6 +31,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +58,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
-description: A plugin to edit Markdown text in Administrate
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: A plugin to handle Markdown text in Administrate
 email:
 - michele.gerarduzzi@gmail.com
 executables: []
@@ -60,11 +94,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
+- Rakefile
 - administrate-field-simple_markdown.gemspec
 - app/assets/javascripts/administrate-field-simple_markdown/application.js
 - app/assets/stylesheets/administrate-field-simple_markdown/application.css
@@ -73,6 +108,8 @@ files:
 - app/views/fields/simple_markdown/_show.html.erb
 - demo.gif
 - lib/administrate/field/simple_markdown.rb
+- spec/lib/administrate/field/simple_markdown_spec.rb
+- spec/spec_helper.rb
 - vendor/assets/javascripts/simplemde.min.js
 - vendor/assets/stylesheets/simplemde.min.css
 homepage: https://github.com/zooppa/administrate-field-simple_markdown
@@ -95,8 +132,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: A plugin to edit Markdown text in Administrate
-test_files: []
+summary: Markdown editor for Administrate
+test_files:
+- spec/lib/administrate/field/simple_markdown_spec.rb
+- spec/spec_helper.rb

data/Gemfile.lock

@@ -1,161 +0,0 @@
-PATH
-  remote: .
-  specs:
-    administrate-field-simple_markdown (0.0.4)
-      administrate (< 1.0.0)
-      rails (>= 4.2)
-      redcarpet (~> 3.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (5.0.2)
-      actionpack (= 5.0.2)
-      nio4r (>= 1.2, < 3.0)
-      websocket-driver (~> 0.6.1)
-    actionmailer (5.0.2)
-      actionpack (= 5.0.2)
-      actionview (= 5.0.2)
-      activejob (= 5.0.2)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (5.0.2)
-      actionview (= 5.0.2)
-      activesupport (= 5.0.2)
-      rack (~> 2.0)
-      rack-test (~> 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.2)
-      activesupport (= 5.0.2)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.0.2)
-      activesupport (= 5.0.2)
-      globalid (>= 0.3.6)
-    activemodel (5.0.2)
-      activesupport (= 5.0.2)
-    activerecord (5.0.2)
-      activemodel (= 5.0.2)
-      activesupport (= 5.0.2)
-      arel (~> 7.0)
-    activesupport (5.0.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    administrate (0.4.0)
-      autoprefixer-rails (~> 6.0)
-      bourbon (~> 4.2)
-      datetime_picker_rails (~> 0.0.7)
-      jquery-rails (~> 4.0)
-      kaminari (~> 0.16)
-      momentjs-rails (~> 2.8)
-      neat (~> 1.1)
-      normalize-rails (~> 3.0)
-      rails (>= 4.2, < 5.1)
-      sass-rails (~> 5.0)
-      selectize-rails (~> 0.6)
-    arel (7.1.4)
-    autoprefixer-rails (6.7.7)
-      execjs
-    bourbon (4.3.3)
-      sass (~> 3.4)
-      thor (~> 0.19)
-    builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    datetime_picker_rails (0.0.7)
-      momentjs-rails (>= 2.8.1)
-    erubis (2.7.0)
-    execjs (2.7.0)
-    globalid (0.3.7)
-      activesupport (>= 4.1.0)
-    i18n (0.8.1)
-    jquery-rails (4.2.2)
-      rails-dom-testing (>= 1, < 3)
-      railties (>= 4.2.0)
-      thor (>= 0.14, < 2.0)
-    kaminari (0.17.0)
-      actionpack (>= 3.0.0)
-      activesupport (>= 3.0.0)
-    loofah (2.0.3)
-      nokogiri (>= 1.5.9)
-    mail (2.6.4)
-      mime-types (>= 1.16, < 4)
-    method_source (0.8.2)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    mini_portile2 (2.1.0)
-    minitest (5.10.1)
-    momentjs-rails (2.17.1)
-      railties (>= 3.1)
-    neat (1.8.0)
-      sass (>= 3.3)
-      thor (~> 0.19)
-    nio4r (2.0.0)
-    nokogiri (1.7.1)
-      mini_portile2 (~> 2.1.0)
-    normalize-rails (3.0.3)
-    rack (2.0.1)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (5.0.2)
-      actioncable (= 5.0.2)
-      actionmailer (= 5.0.2)
-      actionpack (= 5.0.2)
-      actionview (= 5.0.2)
-      activejob (= 5.0.2)
-      activemodel (= 5.0.2)
-      activerecord (= 5.0.2)
-      activesupport (= 5.0.2)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 5.0.2)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.2)
-      activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (5.0.2)
-      actionpack (= 5.0.2)
-      activesupport (= 5.0.2)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (12.0.0)
-    redcarpet (3.4.0)
-    sass (3.4.23)
-    sass-rails (5.0.6)
-      railties (>= 4.0.0, < 6)
-      sass (~> 3.1)
-      sprockets (>= 2.8, < 4.0)
-      sprockets-rails (>= 2.0, < 4.0)
-      tilt (>= 1.1, < 3)
-    selectize-rails (0.12.4)
-    sprockets (3.7.1)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.0)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    thor (0.19.4)
-    thread_safe (0.3.6)
-    tilt (2.0.7)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    websocket-driver (0.6.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  administrate-field-simple_markdown!
-
-BUNDLED WITH
-   1.14.6