lorem_ipsum_amet 0.3.1 → 0.4.0

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.4.0 (2012-12-10)
+
+* Added alternative short syntax: #lorem_ipsum(c: X), #lorem_ipsum(p: X), #lorem_ipsum(w: X)
+* Added short methods: #c(X), #p(X), #w(X)
+

data/README.md

@@ -1,77 +1,95 @@
 # Lorem Ipsum Amet - blind text generator
 ===========
 
-**Lorem Ipsum Amet** provides a simple yet powerful DSL for generating blind text in your projects.
+**Lorem Ipsum Amet** is a gem that provides a simple yet powerful DSL for generating blind texts in your **Ruby** or **Ruby on Rails** projects.
+
+Lots of shortcuts have been incorporated in order to make the DSL concise yet expressive to avoid lots of typing.
 
 ## Installation
 
 Add it to your Gemfile:
 
-`gem 'lorem-ipsum-amet'`
+    gem 'lorem-ipsum-amet'
 
 And run:
 
-`bundle install`
+    bundle install
 
 to install it.
 
 ## Usage
 
-The gem provides all of its features through the namespace LoremIpsum. If you are using it in a Rails project, refer to the next section.
+The gem provides all of its features through the namespace LoremIpsum. If you are using it in a **Rails** project, refer to the next section.
 
 ### Examples
 
 #### Get some lorem ipsum!
 
-`LoremIpsum.lorem_ipsum` or
-(alternatively) `LoremIpsum.text`
+    LoremIpsum.lorem_ipsum
+
+or (alternatively)
+
+    LoremIpsum.text
 
 #### Characters
 
 Get 100 characters:
 
-`LoremIpsum.lorem_ipsum(100)` or
-`LoremIpsum.lorem_ipsum(characters: 100)`
+    LoremIpsum.lorem_ipsum(100)
+
+    LoremIpsum.lorem_ipsum(characters: 100)
+
+    LoremIpsum.lorem_ipsum(c: 100)
+
+    LoremIpsum.c(100)
 
 #### Paragraph
 
 Get 3 paragraphs:
 
-`LoremIpsum.lorem_ipsum(paragraphs: 3)`
+    LoremIpsum.lorem_ipsum(paragraphs: 3)
+
+    LoremIpsum.lorem_ipsum(p: 3)
+
+    LoremIpsum.c(3)
 
 #### Words
 
 Get 200 words:
 
-`LoremIpsum.lorem_ipsum(words: 3)`
+    LoremIpsum.lorem_ipsum(words: 3)
+
+    LoremIpsum.lorem_ipsum(w: 3)
+
+    LoremIpsum.w(200)
 
 #### HTML
 
 Get 5 paragraphs with `<br />` breaks instead of `\n`:
 
-`LoremIpsum.lorem_ipsum(paragraphs: 5, html: true)`
+    LoremIpsum.lorem_ipsum(paragraphs: 5, html: true)
 
 #### Custom paragraph join
 
-Get 3 paragraphs joined by `\r\n`:
+Get 3 paragraphs joined by \r\n:
 
-`LoremIpsum.lorem_ipsum(paragraphs: 3, join: "\r\n")`
+    LoremIpsum.lorem_ipsum(paragraphs: 3, join: "\r\n")
 
 #### Text formatting
 
-Use the `format` parameter.
+Use the format parameter.
 
 Title case:
 
-`LoremIpsum.lorem_ipsum(10, format: :title_case)`
+    LoremIpsum.lorem_ipsum(10, format: :title_case)
 
 Upcase:
 
-`LoremIpsum.lorem_ipsum(10, format: :upcase)`
+    LoremIpsum.lorem_ipsum(10, format: :upcase)
 
 Downcase:
 
-`LoremIpsum.lorem_ipsum(10, format: :downcase)`
+    LoremIpsum.lorem_ipsum(10, format: :downcase)
 
 #### Different text lengths
 
@@ -79,36 +97,36 @@ There are also some shortcuts for getting different text lengths.
 
 Short:
 
-`LoremIpsum.short`
+    LoremIpsum.short
 
 Medium:
 
-`LoremIpsum.medium`
-`LoremIpsum.medium("<br />")`
+    LoremIpsum.medium
+    LoremIpsum.medium("<br />")
 
 Long:
 
-`LoremIpsum.long`
-`LoremIpsum.long("<br />")`
+    LoremIpsum.long
+    LoremIpsum.long("<br />")
 
 Very long:
 
-`LoremIpsum.very_long`
-`LoremIpsum.very_long("<br />")`
+    LoremIpsum.very_long
+    LoremIpsum.very_long("<br />")
 
 ### Rails integration
 
-If you are using this gem in a Rails project, you can access the helper method `lorem_ipsum` to get exactly the same functionality as described in the examples before.
+If you are using this gem in a Rails project, you can access the helper method lorem_ipsum to get exactly the same functionality as described in the examples before.
 
 The html option is activated by default.
 
 ERB:
 
-`<%= text_area_tag 'placeholder', lorem_ipsum %>`
+    <%= text_area_tag 'placeholder', lorem_ipsum %>
 
 HAML:
 
-`%p= lorem_ipsum(paragraphs: 5)`
+    %p= lorem_ipsum(paragraphs: 5)
 
 ## Bug reports and contributions
 
@@ -120,5 +138,5 @@ If you discover any bugs or need a feature, feel free to create an issue on GitH
 
 ## License
 
-MIT License.
+MIT License. Refer to [License file](https://github.com/yagooar/lorem_ipsum_amet/blob/master/LICENSE.txt)
 

data/Rakefile

@@ -18,8 +18,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = 'lorem_ipsum_amet'
   gem.homepage = 'http://yagooar.github.com/lorem_ipsum_amet/'
   gem.license = 'MIT'
-  gem.summary = %Q{Lorem Ipsum generator}
-  gem.description = %Q{Generate blind texts with different configurations}
+  gem.summary = %Q{Lorem Ipsum generator for Ruby and Rails}
+  gem.description = %Q{Generate blind texts with tons of options in Ruby and Ruby on Rails}
   gem.email = 'yagooar@gmail.com'
   gem.authors = ['Mateusz Sojka']
   gem.require_paths = ['lib']

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/lorem_ipsum_amet/base.rb

@@ -14,10 +14,16 @@ module LoremIpsumAmet
 
       if params[:characters]
         Character.new(self, params.delete(:characters), join_element).text
+      elsif params[:c]
+        Character.new(self, params.delete(:c), join_element).text
       elsif params[:paragraphs]
         Paragraph.new(self, params.delete(:paragraphs), join_element).text
+      elsif params[:p]
+        Paragraph.new(self, params.delete(:p), join_element).text
       elsif params[:words]
         Word.new(self, params.delete(:words), join_element).text
+      elsif params[:w]
+        Word.new(self, params.delete(:w), join_element).text
       else
         paragraphs.first
       end
@@ -30,24 +36,36 @@ module LoremIpsumAmet
     end
 
     def short
-      Word.new(self, 8, nil).text
+      lorem_ipsum(words: 8)
     end
 
     def medium(join_element = "\n")
-      Paragraph.new(self, 2, join_element).text
+      lorem_ipsum(paragraphs: 2, join: join_element)
     end
 
     def long(join_element = "\n")
-      Paragraph.new(self, 8, join_element).text
+      lorem_ipsum(paragraphs: 8, join: join_element)
     end
 
     def very_long(join_element = "\n")
-      Paragraph.new(self, 24, join_element).text
+      lorem_ipsum(paragraphs: 24, join: join_element)
     end
 
     # http://goo.gl/m0MMz ;)
     def the_lord_of_the_rings_long(join_element = "\n")
-      Word.new(self, 500000, join_element).text
+      lorem_ipsum(words: 500000, join: join_element)
+    end
+
+    def c(characters, join_element = "\n")
+      lorem_ipsum(characters, join: join_element)
+    end
+
+    def p(paragraphs, join_element = "\n")
+      lorem_ipsum(paragraphs: paragraphs, join: join_element)
+    end
+
+    def w(words, join_element = "\n")
+      lorem_ipsum(words: words, join: join_element)
     end
 
     private

data/spec/lorem_ipsum/base_spec.rb

@@ -32,6 +32,10 @@ describe LoremIpsumAmet::Base do
         expect(subject.lorem_ipsum(characters: 20)).to eq(first_paragraph[0...20])
       end
 
+      it 'returns a given amount of characters (short syntax)' do
+        expect(subject.lorem_ipsum(c: 20)).to eq(first_paragraph[0...20])
+      end
+
       describe 'join element' do
 
         it 'returns paragraphs separated by the given join element' do
@@ -48,6 +52,20 @@ describe LoremIpsumAmet::Base do
 
       end
 
+      describe '#c' do
+
+        it 'returns the given number of characters' do
+          expect(subject.c(25)).to eq(first_paragraph[0...25])
+        end
+
+        it 'returns the given number of characters with custom join' do
+          two_paragraphs = [first_paragraph, second_paragraph].join("\r\n")
+
+          expect(subject.c(two_paragraphs.length, "\r\n")).to eq(two_paragraphs)
+        end
+
+      end
+
     end
 
     describe 'paragraphs' do
@@ -57,6 +75,11 @@ describe LoremIpsumAmet::Base do
         expect(subject.lorem_ipsum(paragraphs: 2)).to eq(two_paragraphs)
       end
 
+      it 'returns a given amount of paragraphs (short syntax)' do
+        two_paragraphs = [first_paragraph, second_paragraph].join("\n")
+        expect(subject.lorem_ipsum(p: 2)).to eq(two_paragraphs)
+      end
+
       it 'returns a given amount of paragraphs (more paragraphs than in raw text)' do
         seven_paragraphs = [raw_text, first_paragraph].join("\n")
         expect(subject.lorem_ipsum(paragraphs: 7)).to eq(seven_paragraphs)
@@ -76,6 +99,23 @@ describe LoremIpsumAmet::Base do
           expect(subject.lorem_ipsum(paragraphs: 2, html: true)).to eq(two_paragraphs)
         end
 
+
+        describe '#p' do
+
+          it 'returns the given number of paragraphs' do
+            two_paragraphs = [first_paragraph, second_paragraph].join("\n")
+
+            expect(subject.p(2)).to eq(two_paragraphs)
+          end
+
+          it 'returns the given number of paragraphs (with custom join)' do
+            two_paragraphs = [first_paragraph, second_paragraph].join("\r\n")
+
+            expect(subject.p(2, "\r\n")).to eq(two_paragraphs)
+          end
+
+        end
+
       end
 
     end
@@ -88,6 +128,12 @@ describe LoremIpsumAmet::Base do
         expect(subject.lorem_ipsum(words: 8)).to eq(eight_words)
       end
 
+      it 'returns a given amount of words (short syntax)' do
+        eight_words = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit.'
+
+        expect(subject.lorem_ipsum(w: 8)).to eq(eight_words)
+      end
+
       it 'returns a given amount of words (more than in the whole text)' do
         seven_paragraphs = [raw_text, first_paragraph].join("\n")
         words = seven_paragraphs.split.size
@@ -101,6 +147,24 @@ describe LoremIpsumAmet::Base do
 
         expect(subject.lorem_ipsum(words: words, join: "\r\n")).to eq(seven_paragraphs)
       end
+
+      describe '#w' do
+
+        it 'returns the given amount of words' do
+          eight_words = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit.'
+
+          expect(subject.w(8)).to eq(eight_words)
+        end
+
+        it 'returns a given amount of words separated by \r\n' do
+          seven_paragraphs = [raw_text, first_paragraph].join("\n").gsub("\n", "\r\n")
+          words = seven_paragraphs.split.size
+
+          expect(subject.w(words, "\r\n")).to eq(seven_paragraphs)
+        end
+
+      end
+
     end
 
     describe 'text format' do
@@ -169,10 +233,12 @@ describe LoremIpsumAmet::Base do
 
   end
 
-  describe '.text' do
-    it 'is an alias of .lorem_ipsum' do
+  describe '#text' do
+
+    it 'is an alias of #lorem_ipsum' do
       expect(subject.method(:text)).to eq(subject.method(:lorem_ipsum))
     end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 # SimpleCov.start
 
 require 'rspec'
-require 'lorem_ipsum'
+require 'lorem_ipsum_amet'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lorem_ipsum_amet
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-09 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -107,7 +107,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Generate blind texts with different configurations
+description: Generate blind texts with tons of options in Ruby and Ruby on Rails
 email: yagooar@gmail.com
 executables: []
 extensions: []
@@ -115,6 +115,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -147,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 26969897705915607
+      hash: 2022820521436179043
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -159,5 +160,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Lorem Ipsum generator
+summary: Lorem Ipsum generator for Ruby and Rails
 test_files: []