hyakunin-issyu 0.8.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4c7c673f748182c1af385f707f69200035d8220
-  data.tar.gz: 4bdc6dadadb812f0636cd5ca22e591768275c347
+  metadata.gz: 2e153c78b134a5fb5ceaf141df6a9cc405c06c1b
+  data.tar.gz: d40bb2dc5bb66c33571be7c54fba8ef3c8b9349f
 SHA512:
-  metadata.gz: 4f7214b2cfa75ba62304f5e3644ccd6ebf6cb47d13b68c59aabab30a15af3a0bc54d3853d13643d2385362db3f050ad92ef1652d9ea6e5197bf1625d12bc4717
-  data.tar.gz: bbd050aabb865f27d6e8440a296ee92026f223eb48493cbb76d9737d75c162772e3694485bfbf81707bb56221b1e131931131319294f1ed79e6f07656799c0d0
+  metadata.gz: b62720cacb60f8c20c2f31a96347158e177f930cfaa9d65eb512f483836088a3f1e4cab1e907127a7f17ff36f4c00ac327535ddae85510cf770ddb2f625f9dbb
+  data.tar.gz: 727c1a7c2bb3916baa144c1ca67afdeb1dbdd22562be444c9f8b8d40a1a94e34a6e4cd949f9b4e3f65913b484ce5013bec799c7d43b18ff9b06cad79c4390d34

data/README.md

@@ -1,19 +1,15 @@
-# HyakuninIssyu
+# hyakunin-issyu
 [![Build Status](https://travis-ci.org/Tomomichi/HyakuninIssyu.png?branch=master)](https://travis-ci.org/Tomomichi/HyakuninIssyu)
 [![Dependency Status](https://gemnasium.com/Tomomichi/HyakuninIssyu.png)](https://gemnasium.com/Tomomichi/HyakuninIssyu)
 
-"HyakuninIssyu" is a Gem for installing poems and poets info of Hyakunin-Issyu, 100 poems by 100 poets into your apps.
-You can take any poems of Hyakunin-Issyu, poets info and a commentary on it, in addition to the feature to take the first or last half of the poem.
-(it may be necessary for building game style Hyakunin-Issyu application)
+All about Hyakunin-Issyu, 100 poems by 100 poets.
 
-HyakuninIssyuは、百人一首の歌情報・歌人情報をアプリに取り込むためのGemです。
-百首すべての歌の歌人情報や解説に加え、上の句、下の句だけの表示も行うことができます。
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'HyakuninIssyu'
+    gem 'hyakunin-issyu'
 
 And then execute:
 
@@ -21,81 +17,97 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install HyakuninIssyu
+    $ gem install hyakunin-issyu
 
 ## Usage
-First, you need to make the instance of HyakuninIssyu class.
 
-    data = HyakuninIssyu.new
+    $ irb
+    irb> require "HyakuninIssyu"
 
-Then use this to retrieve poem and poet data.
 
-###Poem Info | 歌情報の取得
-When retrieving the 64th poem (it's one of my favourite), what you can do is:
+### Poem | 歌情報
+To retrieve the 64th poem (it's one of my favourite), you can do:
 
-    poem_data = data.poem(64)
+```ruby
+poem = HyakuninIssyu.find(64).poem  
+#=> "朝ぼらけ 宇治の川霧 たえだえに あらはれわたる 瀬々の網代木"
 
-    poem_data.kanji   #=> "朝ぼらけ 宇治の川霧 たえだえに あらはれわたる 瀬々の網代木"
-    poem_data.kana   #=> "あさぼらけうじのかわぎりたえだえに　あらはれわたるせぜのあじろぎ"
-    poem_data.en   #=> "In the early dawn When the mists on Uji River Slowly lift and clear,  From the shallows to the deep, The stakes of fishing nets appear."
+poem.kanji   #=> "朝ぼらけ 宇治の川霧 たえだえに あらはれわたる 瀬々の網代木"
+poem.kana   #=> "あさぼらけうじのかわぎりたえだえに　あらはれわたるせぜのあじろぎ"
+poem.en   #=> "In the early dawn When the mists on Uji River Slowly lift and clear,  From the shallows to the deep, The stakes of fishing nets appear."
 
-    poem_data.first.kanji   #=> "朝ぼらけ宇治の川霧たえだえに"
-    poem_data.first.kana   #=> "あさぼらけうじのかわぎりたえだえに"
-    poem_data.first.en   #=> "In the early dawn When the mists on Uji River Slowly lift and clear,"
+# Retrieve only the first half of the poem
+poem.first   #=> "朝ぼらけ宇治の川霧たえだえに"
+poem.first.kanji   #=> "朝ぼらけ宇治の川霧たえだえに"
+poem.first.kana   #=> "あさぼらけうじのかわぎりたえだえに"
+poem.first.en   #=> "In the early dawn When the mists on Uji River Slowly lift and clear,"
 
-    poem_data.last.kanji   #=> "あらはれわたる瀬々の網代木"
-    poem_data.last.kana   #=> "あらはれわたるせぜのあじろぎ"
-    poem_data.last.en   #=> "From the shallows to the deep, The stakes of fishing nets appear."
+# Retrieve only the last half of the poem
+poem.last   #=> "あらはれわたる瀬々の網代木"
+poem.last.kanji   #=> "あらはれわたる瀬々の網代木"
+poem.last.kana   #=> "あらはれわたるせぜのあじろぎ"
+poem.last.en   #=> "From the shallows to the deep, The stakes of fishing nets appear."
 
-    poem_data.comment   #=> "「朝ぼらけ」は夜明けであたりがほのぼのと明るくなってくる頃..."
+poem.comment   #=> "「朝ぼらけ」は夜明けであたりがほのぼのと明るくなってくる頃..."
+```
 
-###Poet Info | 歌人情報の取得
-To retrieve the poet info for the same poem,
+### Poet | 歌人情報
+To retrieve the poet info of the poem, you can do:
 
-    poet_data = data.poet(64)
+```ruby
+poet = HyakuninIssyu.find(64).poet  #=> "権中納言定頼"
 
-    poet_data.name.ja   #=> "権中納言定頼"
-    poet_data.name.en   #=> "Fujiwara no Sadayori"
-    poet_data.period   #=> "995-1045"
-    poet_data.info   #=> "本名は藤原定頼(ふじわらの さだより)。平安時代中期の公家・歌人..."
+poet.name   #=> "権中納言定頼"
+poet.name.ja   #=> "権中納言定頼"
+poet.name.en   #=> "Fujiwara no Sadayori"
+poet.period   #=> "995-1045"
+poet.info   #=> "本名は藤原定頼(ふじわらの さだより)。平安時代中期の公家・歌人..."
 
-    poet_data.male?   #=> true
-    poet_data.female?   #=> false
-    poet_data.monk?   #=> false
-    poet_data.semimaru?   #=> false
+poet.male?   #=> true
+poet.female?   #=> false
+poet.monk?   #=> false
+poet.semimaru?   #=> false
+```
 
-###List of poems and poets | データをまとめて扱うとき
-If you want to list the poems and poets, you can use "poems" and "poets" method to retrieve the raw data of them.
 
-    poems_data = data.poems
-    poems_data[64].kanji   #=> "朝ぼらけ 宇治の川霧 たえだえに あらはれわたる 瀬々の網代木"
-    poems_data[64].kana   #=> "あさぼらけうじのかわぎりたえだえに　あらはれわたるせぜのあじろぎ"
-    poems_data[64].en   #=> "In the early dawn When the mists on Uji River Slowly lift and clear,  From the shallows to the deep, The stakes of fishing nets appear."
-		...
+### Retrieve all records
+To retrieve all 100 poems, you can do:
 
-    poets_data = data.poets
-    poets_data[64].name.ja   #=> "権中納言定頼"
-    poets_data[64].name.en   #=> "Fujiwara no Sadayori"
-    poets_data[64].period   #=> "995-1045"
-		...
+```ruby
+poems = HyakuninIssyu.all
 
-You can use all the method which were shown before, for each content of the poems/poets data.
-Use these to retrieve many poems and poets at the same time.
+poems.each do |p|
+  ...
+end
 
+poems[64].poem   #=> "朝ぼらけ 宇治の川霧 たえだえに あらはれわたる 瀬々の網代木"
+poems[64].poet   #=> "権中納言定頼"
+```
 
-##Use image files of the cards
-Image files of the Hyakunin-Issyu cards are installed in this gem.
-If you wanna use these, it's better to copy them to your project directory.
+### Retrieve sample records
+```ruby
+sample_poems = HyakuninIssyu.all.sample
+#=> [#<HyakuninIssyu::Data:0x007fcffc245918 @id=76>]
 
-The rake task for this is set. Just run the following:
+sample_poems = HyakuninIssyu.all.sample(5)
+=> [#<HyakuninIssyu::Data:0x007fcffc245918 @id=23>, #<Hyakunin...]
+```
 
-    rake HyakuninIssyu:install_img['IMG_PATH']
 
-then "hyakunin-issyu" directory will be created under your IMG_PATH, and
-all the images will be copied there.
+## Assets(images and audio files)
+If you need images or audio files of Hyakunin-Issyu,  
+please use the bower package "hyakunin-issyu-assets".
 
+    bower install hyakunin-issyu-assets
 
-**All the images used in this gem are from Wikipedia and they're under the public license.
+[hyakunin-issyu-assets](https://github.com/notsobad-jp/hyakunin-issyu-assets)
+
+
+### License
+All the images are from Wikipedia and they're under the public license.  
+Audio files are from NHK Library. Please check the license before using it.
+
+[NHK Creative Library](http://www1.nhk.or.jp/creative/rule.html)
 
 
 ## Contributing

data/config/poets.yml

@@ -997,4 +997,3 @@
   monk: 0
   period: 1197-1242
   info: じゅんとくいん。第84代天皇。後鳥羽天皇(99歌)の第三皇子。父・後鳥羽天皇の期待を受け、皇権示威に努めた。父と共に倒幕を企て承久の乱に加わったが失敗。佐渡に流され、断食の末に頭に焼け石を乗せて死んだと伝わる。
-

data/lib/HyakuninIssyu.rb

@@ -1,39 +1,38 @@
 require "yaml"
 
 class HyakuninIssyu
-	def initialize
-		@@poems = YAML.load_file(File.expand_path(File.join('..', '..', 'config', 'poems.yml'), __FILE__))
-		@@poets = YAML.load_file(File.expand_path(File.join('..', '..', 'config', 'poets.yml'), __FILE__))
-	end
-
-	def self.img_path
-    File.expand_path("../../assets/img", __FILE__)
-  end
-
-	def poem(id=nil)
-		return false if id.nil? || id<1 || id>100
-		poem = Poem.new(id)
-	end
+	@@poems = YAML.load_file(File.expand_path(File.join('..', '..', 'config', 'poems.yml'), __FILE__))
+	@@poets = YAML.load_file(File.expand_path(File.join('..', '..', 'config', 'poets.yml'), __FILE__))
 
-	def poet(id=nil)
+	def self.find(id=nil)
 		return false if id.nil? || id<1 || id>100
-		poet = Poet.new(id)
+		Data.new(id)
 	end
 
-	def poems
-		poems = Array.new
+	def self.all
+		all = []
 		for i in 1..100
-			poems[i] = Poem.new(i)
+			all << self.find(i)
 		end
-		return poems
+		all
 	end
 
-	def poets
-		poets = Array.new
-		for i in 1..100
-			poets[i] = Poet.new(i)
+	class Data < self
+		def initialize(id)
+			@id = id
+		end
+
+		def inspect
+			self.poem.inspect
+		end
+
+		def poem
+			Poem.new(@id)
+		end
+
+		def poet
+			Poet.new(@id)
 		end
-		return poets
 	end
 
 	class Poem < self
@@ -41,6 +40,10 @@ class HyakuninIssyu
 			@poem = @@poems[id-1]
 		end
 
+		def inspect
+			self.kanji
+		end
+
 		def id
 			@poem['id']
 		end
@@ -84,6 +87,10 @@ class HyakuninIssyu
 				@first_en = en_data[0]
 			end
 
+			def inspect
+				self.kanji
+			end
+
 			def kana
 				@first_kana
 			end
@@ -112,6 +119,10 @@ class HyakuninIssyu
 				@last_en = en_data[1]
 			end
 
+			def inspect
+				self.kanji
+			end
+
 			def kana
 				@last_kana
 			end
@@ -131,6 +142,10 @@ class HyakuninIssyu
 			@poet = @@poets[id-1]
 		end
 
+		def inspect
+			self.name.inspect
+		end
+
 		def id
 			@poet['id']
 		end
@@ -144,6 +159,10 @@ class HyakuninIssyu
 				@name = data['name']
 			end
 
+			def inspect
+				self.ja
+			end
+
 			def ja
 				@name['ja']
 			end

data/lib/HyakuninIssyu/version.rb

@@ -1,3 +1,3 @@
 class HyakuninIssyu
-  VERSION = "0.8.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyakunin-issyu
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 1.0.0
 platform: ruby
 authors:
 - tomomichi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2015-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler