rubicure 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9eaedd51eb5a6f8711b02e805ed6ff5df4f2ba86ecc8a36a994e932744eb6aba
-  data.tar.gz: 4f69d58ad1faf672177f74ccd66baae3d1c7d6c18602ee88da164e7d96e89433
+  metadata.gz: 77576d01a0785c3932fca19034134f7cd731520060bdfdcf79ee8967cff6e267
+  data.tar.gz: 7d5a5dda89f8ccb92351f977b83f4aae2884e88c093baf99f5b6fc41998d5c6d
 SHA512:
-  metadata.gz: 63aec3560071736f04ab722f3fbb37a1317d3664b4ac219cc931e3b2edb8b32d92b7f946b34fcee16bf1dfafcdcf555b20671b8797319eacdd3753c0fddf0fb7
-  data.tar.gz: 424dd82141401d8e7543c18702e483b3258ce12bbc25918ac43e8afb8612f05fdf9058bf819e900ca6c22d9de1a120eef75d54e9dccd4118df7192c75c7c3433
+  metadata.gz: 168ce2b5cc01000cd47ce2ee90c3d96abc14406dcfbf69002a0199eeb7d43dc018360ad81da5e0d239fedcb94425e3b63d3ac0e6f0656a21833acc7f571a0df0
+  data.tar.gz: ee3514f8b22234dc7b2bb8bc3c19df339f7a445d960a77567c082e63649de3227342f914bff267fd2186d618eccb3fc372274dc74d019f15a8455228a64b86ee

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## master
-[full changelog](http://github.com/sue445/rubicure/compare/v1.1.1...master)
+[full changelog](http://github.com/sue445/rubicure/compare/v1.1.2...master)
+
+## v1.1.2
+[full changelog](http://github.com/sue445/rubicure/compare/v1.1.1...v1.1.2)
+
+* Add Cure Etoile Birthday :birthday:
+  * https://github.com/sue445/rubicure/pull/167
 
 ## v1.1.1
 [full changelog](http://github.com/sue445/rubicure/compare/v1.1.0...v1.1.1)

data/README.md

@@ -482,6 +482,15 @@ Precure.dream_stars.map(&:precure_name)
 #=> ["キュアフローラ", "キュアマーメイド", "キュアトゥインクル", "キュアスカーレット", "キュアミラクル", "キュアマジカル", "キュアフェリーチェ", "キュアホイップ", "キュアカスタード", "キュアジェラート", "キュアマカロン", "キュアショコラ"]
 ```
 
+### `Precure.super_stars`
+```ruby
+Precure.super_stars.count
+#=> 12
+
+Precure.super_stars.map(&:precure_name)
+#=> ["キュアミラクル", "キュアマジカル", "キュアフェリーチェ", "キュアホイップ", "キュアカスタード", "キュアジェラート", "キュアマカロン", "キュアショコラ", "キュアパルフェ", "キュアエール", "キュアアンジュ", "キュアエトワール"]
+```
+
 ### Equivalence
 ```ruby
 yayoi = Cure.peace.dup

data/config/girls/015_hugtto.yml

@@ -55,7 +55,7 @@ cure_etoile: &cure_etoile
   cast_name:    小倉唯
   color:        yellow
   created_date: 2018-03-04 # episode 5
-  # birthday:
+  birthday: 4/8
   transform_message: |-
     ミライクリスタル！
     ハートキラっと！

data/lib/rubicure.rb

@@ -22,12 +22,14 @@ module Precure
 end
 
 module Shiny
+  # @return [Rubicure::Girl] Shiny luminous
   def self.luminous
     Rubicure::Girl.find(:luminous)
   end
 end
 
 module Milky
+  # @return [Rubicure::Girl] Milky rose
   def self.rose
     Rubicure::Girl.find(:rose)
   end

data/lib/rubicure/concerns/util.rb

@@ -2,7 +2,8 @@ module Rubicure
   module Concerns
     # utility methods
     module Util
-      # @param arg
+      # @param arg [Date,Time,String]
+      #
       # @return [Date] arg is String or Date
       # @return [Time] arg is Time
       # @return [nil] arg is other

data/lib/rubicure/core.rb

@@ -28,8 +28,16 @@ module Rubicure
       unmarked_precure.respond_to?(name)
     end
 
-    # @return [Series] current precure
-    # @raise not onair!
+    # rubocop:disable Metrics/LineLength
+
+    # get current precure series
+    # @return [Rubicure::Series] current precure
+    #
+    # @raise [NotOnAirError] not onair!
+    #
+    # @example
+    #   Precure.now
+    #   #=> {:series_name=>"go_princess", :title=>"Go!プリンセスプリキュア", :started_date=>Sun, 01 Feb 2015, :girls=>["cure_flora", "cure_mermaid", "cure_twinkle", "cure_scarlet"]}
     def now
       current_time = Time.now
       each_with_series do |series|
@@ -37,11 +45,56 @@ module Rubicure
       end
       raise NotOnAirError, "Not on air precure!"
     end
+    # rubocop:enable Metrics/LineLength
 
     alias_method :current, :now
 
+    # Get precure all stars
+    #
     # @param [Time,Date,String,Symbol] arg Time, Date or date like String (ex. "2013-12-16")
+    #
     # @return [Array<Rubicure::Girl>]
+    #
+    # @example precure all stars
+    #   Precure.all_stars.count
+    #   Precure.all_stars.map(&:precure_name)
+    #   # returns current precure count and names
+    #
+    #   Precure.all_stars.include?(Cure.echo)
+    #   #=> false
+    #
+    #   Precure.all_stars("2013-10-26").count
+    #   #=> 33
+    #
+    #   Precure.all_stars(:dx).count
+    #   #=> 14
+    #
+    #   Precure.all_stars(:dx2).count
+    #   #=> 17
+    #
+    #   Precure.all_stars(:dx3).count
+    #   #=> 21
+    #
+    #   Precure.all_stars(:new_stage).count
+    #   #=> 29
+    #   Precure.all_stars(:new_stage).include?(Cure.echo)
+    #   #=> true
+    #
+    #   Precure.all_stars(:new_stage2).count
+    #   #=> 32
+    #
+    #   Precure.all_stars(:new_stage3).count
+    #   #=> 37
+    #   Precure.all_stars(:new_stage3).include?(Cure.echo)
+    #   #=> true
+    #
+    #   Precure.all_stars(:spring_carnival).count
+    #   #=> 40
+    #
+    #   Precure.all_stars(:sing_together_miracle_magic).count
+    #   #=> 44
+    #   Precure.all_stars(:sing_together_miracle_magic).include?(Cure.echo)
+    #   #=> true
     def all_stars(arg = Time.current)
       extra_girls = []
 
@@ -66,8 +119,22 @@ module Rubicure
       all_girls(date) - [Cure.echo] + extra_girls
     end
 
+    # Get all precures
+    #
     # @param [Time,Date] arg Time, Date or date like String (ex. "2013-12-16")
-    # @return [Array<Rubicure::Girl>]
+    #
+    # @return [Array<Rubicure::Girl>] all precures
+    #
+    # @example
+    #   Precure.all_girls.count
+    #   Precure.all_girls.map(&:precure_name)
+    #   # returns current precure count and names
+    #
+    #   Precure.all_girls("2013-10-26").count
+    #   #=> 33
+    #
+    #   Precure.all_girls.include?(Cure.echo)
+    #   #=> true
     def all_girls(arg = Time.current)
       date = to_date(arg)
 
@@ -85,6 +152,16 @@ module Rubicure
 
     alias_method :all, :all_girls
 
+    # Get precure dream stars
+    #
+    # @return [Array<Rubicure::Girl>] precure dream stars
+    #
+    # @example
+    #   Precure.dream_stars.count
+    #   #=> 12
+    #
+    #   Precure.dream_stars.map(&:precure_name)
+    #   #=> ["キュアフローラ", "キュアマーメイド", "キュアトゥインクル", "キュアスカーレット", "キュアミラクル", "キュアマジカル", "キュアフェリーチェ", "キュアホイップ", "キュアカスタード", "キュアジェラート", "キュアマカロン", "キュアショコラ"]
     def dream_stars
       return @dream_stars if @dream_stars
       girls = Precure.go_princess.girls + Precure.maho_girls.girls + Precure.a_la_mode.girls
@@ -95,6 +172,16 @@ module Rubicure
       @dream_stars
     end
 
+    # Get precure super stars
+    #
+    # @return [Array<Rubicure::Girl>] precure super stars
+    #
+    # @example
+    #   Precure.super_stars.count
+    #   #=> 12
+    #
+    #   Precure.super_stars.map(&:precure_name)
+    #   #=> ["キュアミラクル", "キュアマジカル", "キュアフェリーチェ", "キュアホイップ", "キュアカスタード", "キュアジェラート", "キュアマカロン", "キュアショコラ", "キュアパルフェ", "キュアエール", "キュアアンジュ", "キュアエトワール"]
     def super_stars
       return @super_stars if @super_stars
       girls = Precure.maho_girls.girls + Precure.a_la_mode.girls + Precure.hugtto.girls

data/lib/rubicure/girl.rb

@@ -24,16 +24,19 @@ module Rubicure
 
     attr_accessor :io
 
+    # @return [Integer]
     def current_state
       @current_state ||= 0
     end
 
+    # @return [Array<String>]
     def state_names
       state_names = [human_name, precure_name]
       state_names += Array.wrap(extra_names) if respond_to?(:extra_names)
       state_names
     end
 
+    # @return [Boolean]
     def ==(other)
       other.is_a?(self.class) && self.human_name == other.human_name
     end
@@ -45,7 +48,28 @@ module Rubicure
     alias_method :to_s, :name
 
     # human -> precure ( -> extra forms ) -> human ...
+    #
+    # @param style [Symbol]
+    #
     # @return [Rubicure::Girl] self
+    #
+    # @example
+    #   yayoi = Cure.peace
+    #
+    #   yayoi.name
+    #   #=> "黄瀬やよい"
+    #
+    #   yayoi.transform!
+    #
+    #   # (レディ？)
+    #   # プリキュア・スマイルチャージ！
+    #   # (ゴー！ゴー！レッツ・ゴー！ピース！！)
+    #   # ピカピカピカリンジャンケンポン！ キュアピース！
+    #   # 5つの光が導く未来！
+    #   # 輝け！スマイルプリキュア！
+    #
+    #   yayoi.name
+    #   #=> "キュアピース"
     def transform!(style = nil)
       if style
         raise "Unknown style: #{style}" unless has_transform_style?(style)
@@ -58,12 +82,34 @@ module Rubicure
       self
     end
 
+    # Rollback to human
+    #
+    # @example
+    #   yayoi = Cure.peace
+    #   yayoi.transform!
+    #   yayoi.name
+    #   #=> "キュアピース"
+    #
+    #   yayoi.humanize!
+    #   yayoi.name
+    #   #=> "黄瀬やよい"
     def humanize!
       @current_state = 0
       @current_transform_style = nil
       self
     end
 
+    # Attack to enemy
+    #
+    # @raise [RequireTransformError] current form is human
+    #
+    # @example
+    #   yayoi = Cure.peace
+    #   yayoi.transform!
+    #
+    #   yayoi.attack!
+    #
+    #   # プリキュア！ピースサンダー！！
     def attack!
       raise RequireTransformError, "require transform" if current_attack_message.blank?
 
@@ -72,6 +118,15 @@ module Rubicure
       current_attack_message
     end
 
+    # Whether `date` is her birthday
+    #
+    # @param date [Date]
+    #
+    # @return [Boolean]
+    #
+    # @example
+    #   Cure.twinkle.birthday?(Date.parse("2015-9-12"))
+    #   #=> true
     def birthday?(date = Date.today)
       return false unless have_birthday?
 
@@ -83,11 +138,24 @@ module Rubicure
       birthday_date == date
     end
 
+    # Whether she has birthday
+    #
+    # @return [Boolean]
+    #
+    # @example
+    #   Cure.peace.have_birthday?
+    #   #=> false
+    #
+    #   Cure.twinkle.has_birthday?
+    #   #=> true
     def have_birthday? # rubocop:disable Naming/PredicateName
       has_key?(:birthday)
     end
     alias_method :has_birthday?, :have_birthday?
 
+    # returns `human_full_name` or `human_name`
+    #
+    # @return [String]
     def full_name
       human_full_name.presence || human_name
     end

data/lib/rubicure/series.rb

@@ -10,6 +10,7 @@ module Rubicure
     @config = nil
 
     # @param [Rubicure::Series,Rubicure::Girl] other
+    #
     # @return [Boolean] other is same Rubicure::Series or Rubicure::Series include Rubicure::Girl
     def ===(other)
       case other
@@ -22,7 +23,11 @@ module Rubicure
       end
     end
 
+    # Whether series is on air
+    #
     # @param [Time,Date,String] arg Time, Date or date like String (ex. "2013-12-16")
+    #
+    # @return [Boolean]
     def on_air?(arg)
       date = to_date(arg)
 
@@ -57,6 +62,7 @@ module Rubicure
       girls.each(&block)
     end
 
+    # @return [String] json string
     def to_json(*_args)
       original_hash = {}
       each_without_girls do |k, v|

data/lib/rubicure/version.rb

@@ -1,3 +1,3 @@
 module Rubicure
-  VERSION = "1.1.1".freeze
+  VERSION = "1.1.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubicure
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport