doctor_ipsum 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a0e21e575404366798da35f0f23cb287a6699d8
-  data.tar.gz: b50d84cf8dfae6323c31133bedf603d899246bfc
+  metadata.gz: f6c9a59f74a88b6cebb6e9da69bf6df6ad52de06
+  data.tar.gz: 7860118a5a625051110a6153ec2f15fca3532a0c
 SHA512:
-  metadata.gz: 8246e8738b967221740a01f6523e1282c616b957d623f7398e3a5ded26e585688494361236abab91a07cb0d0e7e553669ef5d613e950fa0e988b1b2129a70d1b
-  data.tar.gz: 10f493de93a66bd61f44ef074f80b059b27594e52518dc2e126707b0872a4e4318b6cda09cdb9ce157210396c81552a8c2cbd1aa07585044b56849f7e49652ca
+  metadata.gz: b7ca0c2f89280725db992915368d9deae7e3109c7c016182015621e52946e884daa6ddd876e9e2beb715b1cf8e4843b17b7992ff71ae566088480b11e692b8d1
+  data.tar.gz: 339d8c81acf7865c4449df0344e9ea23183dc105cb4e784ceb10a7cca14b60e141806ce66260d109a7ac6f1ed127234c523fef30f094b800a8d1a002efa6b557

data/.travis.yml

@@ -1,4 +1,5 @@
 rvm:
+  - 1.9.3
   - 2.0.0
 
 install:

data/README.md

@@ -26,7 +26,63 @@ Or install it yourself as:
 
 ## Usage
 
-TBA
+For basic [Faker](https://github.com/stympy/faker) Lorem Ipsum:
+
+```ruby
+
+    DoctorIpsum::Lorem.sentence
+    => "Qui assumenda mollitia error dolorum nostrum et."
+
+    DoctorIpsum::Lorem.words
+    => ["sit", "vel", "possimus"]
+
+    ...
+
+```
+
+For Markdown:
+
+```ruby
+
+  DoctorIpsum::Markdown.header
+  => "# Aliquam Dolore Voluptatem"
+
+  DoctorIpsum::Markdown.emphasis
+  => "_qui maxime quia_"
+
+  DoctorIpsum::Markdown.blockquote
+  => "> Laborum et sed quisquam rerum\n> ipsum. Est soluta omnis fugit\n> unde.
+  Et totam eaque illo\n> exercitationem itaque neque. Hic unde\n> fugit
+  deserunt non et. Et\n> est velit voluptate nemo quia."
+
+  DoctorIpsum::Markdown.list
+  => "* quis nostrum\n* labore error\n* soluta voluptatem\n* totam expedita\n*
+  dlectus et"
+
+  DoctorIpsum::Markdown.horizontal
+  => "----------"
+
+  DoctorIpsum::Markdown.link
+  => "[Dignissimos omnis aut et deleniti](http://google.com \"et\")"
+
+  DoctorIpsum::Markdown.image
+  => "![Suscipit nostrum distinctio eligendi voluptates repudiandae
+  doloribus](http://placehold.it/459x466 \"consectetur\")"
+
+```
+
+Most of the above functions also take arguments and can be found by
+[here](https://github.com/geekjuice/doctor_ipsum/blob/master/lib/doctor_ipsum/markdown.rb)
+
+
+## Future Plans
+
+Features to look for in future updates:
+
+* Code blocks (regular and Github flavor)
+* More flexibility
+* Full blog post generator
+
 
 ## Contributing
 

data/Rakefile

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

data/lib/doctor_ipsum.rb

@@ -16,3 +16,4 @@ end
 
 require 'doctor_ipsum/version'
 require 'doctor_ipsum/lorem'
+require 'doctor_ipsum/markdown'

data/lib/doctor_ipsum/lorem.rb

@@ -17,12 +17,18 @@ module DoctorIpsum
         words(num_words, supplemental).join(' ').capitalize + '.'
       end
       def sentences(sentence_count = 5, supplemental = false)
-        [].tap { |s| sentence_count.times { s << sentence(5, supplemental) } }
-          .join(' ')
+        [].tap { |s|
+          resolve(sentence_count).times { s << sentence(5, supplemental) }
+        }.join(' ')
       end
 
       def paragraph(sentence_count = 5, supplemental = false)
-        sentences(sentence_count, supplemental)
+        sentences(resolve(sentence_count), supplemental)
+      end
+      def paragraphs(paragraph_count = 5, supplemental = false)
+        [].tap { |p|
+          resolve(paragraph_count).times { p << paragraph(5, supplemental) }
+        }.join("\n\n")
       end
 
     end #END SELF

data/lib/doctor_ipsum/markdown.rb

@@ -0,0 +1,69 @@
+module DoctorIpsum
+  class Markdown < Lorem
+    class << self
+      # Uses Atx-style i.e. ## Header
+      def header(input = nil, level = 1)
+        input ||= words
+        resolve_md(input, true).prepend('#'*[0,level,6].sort[1]+' ')
+      end
+
+      # Uses underscore
+      def emphasis(input = nil, level = 1)
+        input ||= words
+        underscore = '_'*[0,level,2].sort[1]
+        resolve_md(input).prepend(underscore).concat(underscore)
+      end
+
+      # Simple Blockquote (no Markdown inside...yet)
+      def blockquote(input = nil, level = 5)
+        inputs ||= sentences
+        [].tap { |x| resolve_md(input).split(' ').each_slice(level) { |s| x << s.join(' ').prepend('> ') } }.join("\n")
+      end
+
+      # Uses *
+      def list(input = nil, level = 2, ordered = false)
+        input ||= words(10)
+        [].tap { |x|
+          resolve_md(input).split(' ').each_slice(level).with_index { |s,i|
+            x << s.join(' ').prepend((ordered ? (i+1).to_s+'.' : '*')+' ')
+          }
+        }.join("\n")
+      end
+
+      # 10 dashes
+      def horizontal
+        '-'*10
+      end
+
+      # Opinionated link format
+      def link
+        url = (rand(0..1)>0 ? 'google.com' : 'github.com/geekjuice/doctor_ipsum')
+        basic_format( nil, url , nil)
+      end
+
+      # Images from placehold.it
+      def image( width = rand(100..500), height = rand(100..500) )
+        url = 'placehold.it/'+width.to_s+'x'+height.to_s
+        basic_format( nil, url, nil).prepend('!')
+      end
+
+      def basic_format( text = nil, url = nil, tag = nil )
+        text ||= sentence.chomp('.')
+        url  ||= 'google.com'
+        tag  ||= word.join(' ')
+        "[" + text + "](http://" + url + ' "' + tag + '")'
+      end
+
+    end #END SELF
+
+    private
+
+    def self.resolve_md(input, title=false)
+      case input
+        when Array then title ? input.map {|x| x.capitalize}.join(' ') : input.join(' ')
+        else title ? input.split(' ').map {|x| x.capitalize}.join(' ') : input
+      end
+    end
+
+  end
+end

data/lib/doctor_ipsum/version.rb

@@ -1,3 +1,3 @@
 module DoctorIpsum
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/spec/markdown_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'doctor_ipsum'
+
+describe "DoctorIpsum Markdown: " do
+  let(:md) { DoctorIpsum::Markdown }
+
+  describe 'Header' do
+    it 'should add correct header and length' do
+      100.times do
+        level = rand(1..6)
+        md.header( DoctorIpsum::Lorem.sentence(3), level )[0..level-1].should
+          eq('#'*level)
+      end
+    end
+    it 'should have upper bound of 6' do
+      100.times do
+        md.header( DoctorIpsum::Lorem.sentence(3), rand(1..100) ).count('#').should <= 6
+      end
+    end
+  end
+
+  describe 'Emphasis' do
+    it 'should add correct header and length' do
+      100.times do
+        level = rand(1..2)
+        sentence = DoctorIpsum::Lorem.sentence(3)
+        md.emphasis( sentence, level )[0..level-1].should eq('_'*level)
+        md.emphasis( sentence, level )[-level..-1].should eq('_'*level)
+      end
+    end
+
+    it 'should have upper limit of 2' do
+      100.times do
+        md.emphasis( DoctorIpsum::Lorem.sentence(3), rand(1..100) ).count('_').should <= 4
+      end
+    end
+  end
+
+  describe 'Blockquote' do
+    it 'should add > before/after each newline' do
+      100.times do
+        md.blockquote( DoctorIpsum::Lorem.sentence(3), 5 ).split("\n").each do |x|
+          x[0..1].should eq('> ')
+        end
+      end
+    end
+  end
+
+  describe 'List' do
+    it 'should create unordered list' do
+      100.times do
+        md.list( DoctorIpsum::Lorem.words(10) , 3, false).split("\n").each do |x|
+          x[0..1].should eq('* ')
+        end
+      end
+    end
+    it 'should create ordered list' do
+      100.times do
+        md.list( DoctorIpsum::Lorem.words(10) , 3, true).split("\n").each.with_index do |x,i|
+          x[0..2].should eq((i+1).to_s+'. ')
+        end
+      end
+    end
+  end
+
+  describe 'Code block' do
+    pending 'Basic code block, Github flavor fencing, and code source'
+  end
+
+  describe 'Horizontal rules' do
+    it 'should produce 10 dashes' do
+      md.horizontal.should eq('-'*10)
+    end
+  end
+
+  describe 'Links' do
+    simple_link_regex = /\[[^\[\]]+\]\(http[s]?:\/\/[a-zA-Z0-9\/._-]+\s*(")?(?:[^\"]*\"\s*\)|\s*\))/
+    it "should produce correct (opinionated) link format" do
+      100.times { md.link.should match(simple_link_regex) }
+    end
+    pending 'Add other link formats and reference links'
+  end
+
+  describe 'Images' do
+    simple_img_regex = /!\[[^\[\]]+\]\(http[s]?:\/\/[a-zA-Z0-9\/._-]+\s*(")?(?:[^\"]*\"\s*\)|\s*\))/
+    it 'should have correct image format' do
+      100.times { md.image.should match(simple_img_regex) }
+    end
+
+    it 'should produce image with correct placehold.it dims' do
+      100.times do
+        width,height = rand(200..500),rand(200..500)
+        md.image(width, height).should include(width.to_s+"x"+height.to_s)
+      end
+    end
+    pending 'images using local cache'
+  end
+
+end

data/spec/paragraph_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 require 'doctor_ipsum'
 
-describe "DoctorIpsum paragraphs(s): " do
+describe "DoctorIpsum paragraphs(s) and longer: " do
 
   let(:lorem) { DoctorIpsum::Lorem }
 
-  describe 'Lorem Paragrah' do
+  describe 'Lorem Paragraph' do
     it 'should output String, not Array' do
       lorem.paragraph.class.should eq String
       lorem.paragraph.class.should_not eq Array
@@ -19,6 +19,20 @@ describe "DoctorIpsum paragraphs(s): " do
     end
   end
 
+  describe 'Lorem Paragraphs' do
+    it 'should output String, not Array' do
+      lorem.paragraphs.class.should eq String
+      lorem.paragraphs.class.should_not eq Array
+    end
+
+    it 'should produce correct number of paragraphs' do
+      100.times do
+        rn = rand(10)
+        lorem.paragraphs(rn,true).split("\n\n").count.should eq(rn)
+      end
+    end
+  end
+
 end
 
 

data/spec/word_spec.rb

@@ -30,15 +30,6 @@ describe "DoctorIpsum word(s): " do
         lorem.words(rn).count.should eq(rn)
       end
     end
-
-    it 'should resolve array values' do
-      rn = (1..rand(10)+1).map { rand(10)+1 }
-      lorem.words(rn).should_not raise_error
-    end
-
-    it 'should resolve range values' do
-      lorem.words((1..rand(10)+1)).should_not raise_error
-    end
   end
 
   describe 'Lorem words with supplemental' do
@@ -52,15 +43,6 @@ describe "DoctorIpsum word(s): " do
         lorem.words(rn,true).count.should eq(rn)
       end
     end
-
-    it 'should resolve array values' do
-      rn = (1..rand(10)+1).map { rand(10)+1 }
-      lorem.words(rn,true).should_not raise_error
-    end
-
-    it 'should resolve range values' do
-      lorem.words((1..rand(10)+1), true).should_not raise_error
-    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doctor_ipsum
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Nicholas Hwang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-14 00:00:00.000000000 Z
+date: 2013-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -83,9 +83,11 @@ files:
 - ipsum_lorem.md
 - lib/doctor_ipsum.rb
 - lib/doctor_ipsum/lorem.rb
+- lib/doctor_ipsum/markdown.rb
 - lib/doctor_ipsum/version.rb
 - lib/locales/en.yml
 - spec/doctor_lorem_spec.rb
+- spec/markdown_spec.rb
 - spec/paragraph_spec.rb
 - spec/sentence_spec.rb
 - spec/spec_helper.rb
@@ -116,6 +118,7 @@ specification_version: 4
 summary: '["Lorem Ipsum generator with Markdown formatting"]'
 test_files:
 - spec/doctor_lorem_spec.rb
+- spec/markdown_spec.rb
 - spec/paragraph_spec.rb
 - spec/sentence_spec.rb
 - spec/spec_helper.rb