crazipsum 0.1.2 → 0.2.0

data/lib/crazipsum/dictionnary.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Crazipsum
+  # Dictionnary is a simple struct with a #words and #fillers read-only
+  # attributes.
+  # It is used to initialize the Generator instance.
+  class Dictionnary
+    attr_reader :words, :fillers
+
+    def initialize(words, fillers: [])
+      @words = words
+      @fillers = fillers
+    end
+  end
+end

data/lib/crazipsum/generator.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Crazipsum
+  # Generator generates lorem ipsum sentences, paragraphs and text based on a
+  # Dictionnary.
+  class Generator
+    DEFAULT_WORD_COUNT_RANGE = (7..15).freeze
+    DEFAULT_SENTENCE_COUNT_RANGE = (4..7).freeze
+    DEFAULT_PARAGRAPH_COUNT_RANGE = (3..5).freeze
+    DEFAULT_PARAGRAPH_SEPARATOR = "\n\n"
+
+    # Returns a new instance of Generator that will used words and fillers from
+    # the given Dictionnary to generate the lorem ipsum texts.
+    def initialize(dictionnary)
+      @dictionnary = dictionnary
+    end
+
+    # Generates a lorem ipsum sentence based on the generator's dictionnary.
+    #
+    # @param [integer] word_count the number of words expected in the sentence.
+    # @param [Array<String>] fillers a list of words used to fill in the lorem ipsum.
+    # @return [String] a lorem ipsum sentence.
+    def sentence(word_count: rand(DEFAULT_WORD_COUNT_RANGE), fillers: dictionnary.fillers)
+      word_count = 0 if word_count.negative?
+      dictionnary_words = dictionnary.words
+      words = (0...word_count).map do
+        next dictionnary_words.sample if fillers.nil? || fillers == false || fillers.empty?
+
+        rand(3).zero? ? dictionnary_words.sample : fillers.sample
+      end
+      return '' if words.empty?
+
+      words[0] = words[0].capitalize
+      words = words.join(' ')
+      "#{words}."
+    end
+
+    # Generates a lorem ipsum paragraph based on the generator's dictionnary.
+    #
+    # @param [integer] sentence_count the number of sentences expected in the paragraph.
+    # @param [integer] word_count the number of words expected in each sentence.
+    # @param [Array<String>] fillers a list of words used to fill in the lorem ipsum.
+    # @return [String] a lorem ipsum paragraph.
+    def paragraph(
+      word_count: rand(DEFAULT_WORD_COUNT_RANGE),
+      sentence_count: rand(DEFAULT_SENTENCE_COUNT_RANGE),
+      fillers: dictionnary.fillers
+    )
+      sentence_count = 0 if sentence_count.negative?
+      paragraph = []
+      sentence_count.times do
+        s = sentence(word_count: word_count, fillers: fillers)
+        paragraph << s unless s.empty?
+      end
+      paragraph.join(' ')
+    end
+    alias sentences paragraph
+
+    # Generates a lorem ipsum text with multiples paragraphs based on the
+    # generator's dictionnary.
+    #
+    # @param [integer] sentence_count the number of sentences expected in the paragraph.
+    # @param [integer] sentence_count the number of sentences expected in the paragraphs.
+    # @param [integer] word_count the number of words expected in each sentence.
+    # @param [Array<String>] fillers a list of words used to fill in the lorem ipsum.
+    # @return [String] a lorem ipsum text.
+    def paragraphs(
+      word_count: rand(DEFAULT_WORD_COUNT_RANGE),
+      sentence_count: rand(DEFAULT_SENTENCE_COUNT_RANGE),
+      paragraph_count: rand(DEFAULT_PARAGRAPH_COUNT_RANGE),
+      fillers: dictionnary.fillers,
+      seperator: DEFAULT_PARAGRAPH_SEPARATOR
+    )
+      paragraph_count = 0 if paragraph_count.negative?
+      paragraphs = []
+      paragraph_count.times do
+        p = paragraph(word_count: word_count, sentence_count: sentence_count, fillers: fillers)
+        paragraphs << p unless p.empty?
+      end
+      paragraphs.join(seperator)
+    end
+    alias text paragraphs
+
+    private
+
+    attr_reader :dictionnary
+  end
+end

data/lib/crazipsum/registry.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+require 'crazipsum/dictionnary'
+require 'crazipsum/generator'
+
+module Crazipsum
+  # Registry is a singleton class that registers and stores different
+  # dictionnary types.
+  class Registry
+    include Singleton
+
+    def initialize
+      @registry = {}
+    end
+
+    # Registers a new type of Dictionnary that can later be retrieved with #[].
+    #
+    # @param [String,Symbol] type a name for that dictionnary. This type will be
+    #                        used later when calling `Crazipsum(type)`.
+    # @param [Array<String>] words a list of words used when generating the lorem ipsum.
+    # @param [Array<String>, false] fillers a list of words used to fill in the sentences when generating the lorem ipsum.
+    def register(type, words, fillers: [])
+      registry[type.to_s] = Dictionnary.new(words, fillers: fillers)
+    end
+
+    # Retrieves a dictionnary given its type.
+    #
+    # @param [String,Symbol] type the name of the dictionnary to retrieve
+    # @return [Dictionnary,nil] the dictionnary registered for this name. nil if no dictionnary was registered for this type.
+    def [](type)
+      registry[type.to_s]
+    end
+
+    private
+
+    attr_reader :registry
+  end
+end

data/lib/crazipsum/version.rb

@@ -1,3 +1,5 @@
-class Crazipsum
-  VERSION = '0.1.2'.freeze
+# frozen_string_literal: true
+
+module Crazipsum
+  VERSION = '0.2.0'
 end

metadata

@@ -1,85 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: crazipsum
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Yohan Robert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-23 00:00:00.000000000 Z
+date: 2019-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ataru
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0.49'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.20
 description: Ever wanted some dumber, crazier (fancier?) lorem ipsum? Here you go!
 email:
 - yohan.robert@outlook.fr
@@ -96,9 +110,14 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- ataru_setup.rb
 - bin/console
 - bin/setup
 - crazipsum.gemspec
+- data/animal.txt
+- data/car_make.txt
+- data/constellation.txt
+- data/country.txt
 - data/fillers.txt
 - data/fruit.txt
 - data/mineral.txt
@@ -106,11 +125,15 @@ files:
 - data/programming_language.txt
 - data/religion.txt
 - lib/crazipsum.rb
+- lib/crazipsum/dictionnary.rb
+- lib/crazipsum/generator.rb
+- lib/crazipsum/registry.rb
 - lib/crazipsum/version.rb
 homepage: https://www.github.com/groyoh/crazipsum
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -127,9 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Lorem ipsum remixed
 test_files: []
-has_rdoc: