dummy-apartment 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 724ea1784d40a1e3cfc7d729b2679d51639efa21
-  data.tar.gz: e8a1bd601a0e6f06f8131b4e7f282b411234d457
+  metadata.gz: 51f86c8fd8c82def08f9022a7c59126b11dc2bd6
+  data.tar.gz: 9499ffb2cdfb0061fa77f5f410db710edd4e29cc
 SHA512:
-  metadata.gz: e704dc4e4815adf7280e835ac1d39eafb41802c42f95ba93a8375f13261175caf7aaa14298a2224fc5f7aa2eff4bcf066b3f6a9a9a122ae4a76d013563bacb97
-  data.tar.gz: af07e4bbf5b0071f1698bdbaf18e81e9c17e5183454811cad22de83a874673794830849957912564ad90c9aa280eb558e2c56d33ed8008ea4d10addc34518af7
+  metadata.gz: 80d25ab1f3ba7a8cf8ca0fabfcf81f5d72472951086b6a89266cea2f48d8f389f64998913cc1b2e8f74422aa100139c219244716987e09c638ac0444356ec75c
+  data.tar.gz: 7c0efcbf27a06b895cdef2f80cde13d57924eaa9bf04f597228f57854cf5f43cd23bc02b4a408b650a6cec993ce1925bde95ff3a731f4431cb3485bf4e600164

data/README.md

@@ -18,6 +18,21 @@ This gem generates dummy information of apartment including
 * is self-locking door?
 * whether the manager patrols
 * names of closest stations
+* minutes to reach the stations
+  * on foot
+  * by bus
+* whether bath and toilet are in different rooms
+* date of
+  * construction
+  * renovation
+* monthly rent
+* monthly management fee
+* monthly parking price
+* deposit money
+* finder's reward
+* leasing term is fixed or not
+  * the term if it's fixed
+  * renewal fee if it's fixed
 
 ### Installation
 
@@ -51,6 +66,43 @@ Or just:
     apartment.to_hash
     #=> {address: "群馬県長谷市60", building_name: "ハイツ谷川", ... }
 
+#### Instance Methods
+
+* `address`
+* `building_name`
+* `geo`
+* `top_floor`
+* `room_floor`
+* `room_number`
+* `room_type`
+* `occupied_area`
+* `keeping_pets`
+* `playing_the_instruments`
+* `place_for_washing_machine`
+* `floor_type`
+* `flooring?`
+* `tatami?`
+* `exposure`
+* `air_conditioner_equipped?`
+* `self_locking?`
+* `manager_patrol?`
+* `nearest_stations`
+* `minutes_to_stations`
+* `bath_toilet_separated?`
+* `date_of_construction`
+* `renovated?`
+* `date_of_renovation`
+* `monthly_rent`
+* `management_fee`
+* `parking_price`
+* `deposit`
+* `finders_reward`
+* `fixed_term_lease?`
+* `lease_term`
+* `renewal_fee`
+* `to_hash`
+
+
 ### Contributing
 
 1. Fork it ( https://github.com/Joe-noh/dummy-apartment/fork )

data/dummy-apartment.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 1.9.3'
+
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/data.yml

@@ -1,7 +1,7 @@
 prefectures: ["北海道", "青森県", "岩手県", "宮城県", "秋田県", "山形県", "福島県", "茨城県", "栃木県", "群馬県", "埼玉県", "千葉県", "東京都", "神奈川県", "新潟県", "富山県", "石川県", "福井県", "山梨県", "長野県", "岐阜県", "静岡県", "愛知県", "三重県", "滋賀県", "京都府", "大阪府", "兵庫県", "奈良県", "和歌山県", "鳥取県", "島根県", "岡山県", "広島県", "山口県", "徳島県", "香川県", "愛媛県", "高知県", "福岡県", "佐賀県", "長崎県", "熊本県", "大分県", "宮崎県", "鹿児島県", "沖縄県"]
 cities: ["原田市", "熊塚市", "佐々木市", "大応寺市", "野村市", "浦部市", "浦田市", "白田市", "赤田市", "龍ノ浦市", "東海林市", "長谷市", "犬山市", "田所市", "設楽市", "千田市", "大沢市", "名進市", "長郷市", "岡田市", "郷田林市", "遅沢町", "池内町", "東池内町", "高丘町", "泉町", "塚北町", "大井村", "峡谷村", "ドイツ村", "羽生田村", "八つ墓村"]
 building_name:
-  first_half:  ["石井", "山城", "大井台", "片山", "大山", "植木", "長嶺", "東", "南", "西", "北", "市橋", "富岡", "田町", "江頭", "ポール", "牧", "片岡", "鶴", "太郎", "メゾン・ド", "SAKURA", "紫", "碧"]
+  first_half:  ["石井", "山城", "大井台", "片山", "大山", "植木", "長嶺", "東", "南", "西", "北", "市橋", "富岡", "田町", "江頭", "ポール", "牧", "片岡", "鶴", "太郎", "メゾン・ド・", "SAKURA", "紫", "碧"]
   second_half: ["コーポ", "ハイツ", "サンハイツ", "メゾン", "パレス", "ネオパレス", "プロミネンス", "カーサ", "Petit", "プチトマト", "パーク", "ネックス", "エスポワール", "エクセル", "グラン", "コンフォート", "エトワール", "フローラ", "リバティ", "荘"]
 room_type: ["1R", "1K", "1DK", "1LDK", "2K", "2DK", "2LDK", "3K", "3DK", "3LDK"]
 station: ["城東駅", "庄内駅", "白浜駅", "白石駅", "武田駅", "望月駅", "和田駅", "久保駅", "心斎橋駅", "仁木駅", "西ヶ原駅", "東駅", "西駅", "南駅", "北駅", "酒田駅", "桜木駅", "鯖江駅", "藤江駅", "富士見駅", "古川駅", "保見駅", "元町駅", "三雲駅", "水沢駅", "緑駅", "峰山駅", "宮下駅", "武蔵駅", "村山駅", "芝田駅", "中島駅", "鳴門駅", "小岩井駅", "郷間駅", "櫛田駅", "広井公園駅", "ヨウ素駅"]

data/lib/dummy-apartment.rb

@@ -4,7 +4,7 @@ require 'psych'
 require 'date'
 
 class DummyApartment
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
   YML = File.expand_path('../data.yml', __FILE__)
 
   @@dic ||=  Psych.load(File.open(YML).read)
@@ -13,7 +13,8 @@ class DummyApartment
                 :keeping_pets, :playing_the_instruments, :place_for_washing_machine, :floor_type,
                 :exposure, :air_conditioner_equipped, :self_locking, :manager_patrol, :nearest_stations,
                 :minutes_to_stations, :occupied_area, :bath_toilet_separated, :date_of_construction,
-                :date_of_renovation]
+                :date_of_renovation, :monthly_rent, :management_fee, :parking_price, :deposit,
+                :finders_reward, :fixed_term_lease, :lease_term, :renewal_fee]
 
   attr_accessor *ATTRIBUTES
 
@@ -39,6 +40,14 @@ class DummyApartment
     bath_toilet_separated     = gen_true_or_false
     date_of_construction      = gen_date_of_construction
     date_of_renovation        = gen_date_of_renovation(date_of_construction)
+    monthly_rent              = gen_monthly_rent(occupied_area)
+    management_fee            = gen_management_fee
+    parking_price             = gen_parking_price
+    deposit                   = gen_deposit(monthly_rent)
+    finders_reward            = gen_finders_reward(monthly_rent)
+    fixed_term_lease          = gen_true_or_false
+    lease_term                = gen_lease_term(fixed_term_lease)
+    renewal_fee               = gen_renewal_fee(fixed_term_lease, monthly_rent)
 
     values = ATTRIBUTES.map{ |attr| eval "#{attr}" }
     DummyApartment.new(Hash[ATTRIBUTES.zip values])
@@ -76,6 +85,10 @@ class DummyApartment
     !@date_of_renovation.nil?
   end
 
+  def fixed_term_lease?
+    @fixed_term_lease
+  end
+
   def to_hash
     Hash[ATTRIBUTES.map{|attr| [attr, instance_variable_get("@#{attr}")] }]
   end
@@ -155,6 +168,39 @@ class DummyApartment
     [true, false].sample ? rand(older_limit .. Date.today) : nil
   end
 
+  def self.gen_monthly_rent(occupied_area)
+    # base(15m^2) ==  20000
+    # base(65^m2) == 340000
+    base = 80*occupied_area**2 + 2000
+    base.round(-3) + rand(-5 .. 5)*1000
+  end
+
+  def self.gen_management_fee
+    rand(0 .. 10) * 1000
+  end
+
+  def self.gen_parking_price
+    rand(0 .. 10) * 1000
+  end
+
+  def self.gen_deposit(monthly_rent)
+    [0, 1, 1, 1, 1, 2].sample * monthly_rent
+  end
+
+  def self.gen_finders_reward(monthly_rent)
+    [0, 1, 1, 1, 1, 2].sample * monthly_rent
+  end
+
+  def self.gen_lease_term(fixed)
+    return nil unless fixed
+    rand(1 .. 3)
+  end
+
+  def self.gen_renewal_fee(fixed, monthly_rent)
+    return nil unless fixed
+    rand(1 .. 3) * monthly_rent
+  end
+
   private_class_method *self.public_methods.grep(/\Agen_/)
 
   private

data/spec/dummy-apartment_spec.rb

@@ -31,8 +31,8 @@ describe DummyApartment do
 
   it 'should have the accessor methods' do
     DummyApartment::ATTRIBUTES.each do |attr|
-      expect(@apartment.respond_to?          attr).to be_true
-      expect(@apartment.respond_to? "#{attr}=").to be_true
+      expect(@apartment.respond_to?          attr).to be_truthy
+      expect(@apartment.respond_to? "#{attr}=").to be_truthy
     end
   end
 
@@ -183,11 +183,11 @@ describe DummyApartment do
 
         case apartment.floor_type
         when :flooring
-          expect(apartment.flooring?).to be_true
-          expect(apartment.tatami?).to   be_false
+          expect(apartment.flooring?).to be_truthy
+          expect(apartment.tatami?).to   be_falsey
         when :tatami
-          expect(apartment.flooring?).to be_false
-          expect(apartment.tatami?).to   be_true
+          expect(apartment.flooring?).to be_falsey
+          expect(apartment.tatami?).to   be_truthy
         end
       end
     end
@@ -237,7 +237,7 @@ describe DummyApartment do
 
     it 'should be an Array of Strings' do
       expect(nearest_stations).to be_an Array
-      expect(nearest_stations.all?{|s| String === s}).to be_true
+      expect(nearest_stations.all?{|s| String === s}).to be_truthy
     end
 
     it 'should be an Array whose size is one or two' do
@@ -249,7 +249,7 @@ describe DummyApartment do
     describe "Stations' Name" do
       it "should end with '駅'" do
         100.times do
-          expect(Build.nearest_stations.all?{|name| name.end_with? '駅'}).to be_true
+          expect(Build.nearest_stations.all?{|name| name.end_with? '駅'}).to be_truthy
         end
       end
     end
@@ -260,7 +260,7 @@ describe DummyApartment do
 
     it 'should be an Array of Hashes' do
       expect(minutes_to_stations).to be_an Array
-      expect(minutes_to_stations.all?{|h| Hash === h}).to be_true
+      expect(minutes_to_stations.all?{|h| Hash === h}).to be_truthy
     end
 
     it 'should be an Array the size of which is equal to of nearest_stations' do
@@ -325,4 +325,78 @@ describe DummyApartment do
       end
     end
   end
+
+  describe 'Monthly Rent' do
+    it 'should be between 15000 and 305000' do
+      100.times do
+        expect(15000 .. 345000).to include Build.monthly_rent
+      end
+    end
+  end
+
+  describe 'Management Fee' do
+    it 'should be less than or equal to 10000' do
+      expect(Build.management_fee).to be <= 10000
+    end
+  end
+
+  describe 'Parking Price' do
+    it 'should be less than or equal to 10000' do
+      expect(Build.management_fee).to be <= 10000
+    end
+  end
+
+  describe 'Deposit' do
+    it 'should be less than or equal to 2*monthly_rent' do
+      100.times do
+        rent, fee = Build[:monthly_rent, :management_fee]
+        expect(fee).to be <= 2*rent
+      end
+    end
+  end
+
+  describe "Finder's Reward" do
+    it 'should be less than or equal to 2*monthly_rent' do
+      100.times do
+        rent, reward = Build[:monthly_rent, :finders_reward]
+        expect(reward).to be <= 2*rent
+      end
+    end
+  end
+
+  describe 'Fixed Term Lease' do
+    it 'should be equal to #fixed_term_lease?' do
+      100.times do
+        apartment = DummyApartment.generate
+        expect(apartment.fixed_term_lease).to eql apartment.fixed_term_lease?
+      end
+    end
+
+    describe 'Lease Term' do
+      it 'should be between 1 and 3' do
+        100.times do
+          apartment = DummyApartment.generate
+          if apartment.fixed_term_lease?
+            expect(apartment.lease_term).to be_between(1, 3)
+          else
+            expect(apartment.lease_term).to be_nil
+          end
+        end
+      end
+    end
+
+    describe 'Renewal Fee' do
+      it 'should be between monthly_fee and 3*monthly_rent' do
+        100.times do
+          apartment = DummyApartment.generate
+          if apartment.fixed_term_lease?
+            candidates = (1..3).map { |i| i * apartment.monthly_rent }
+            expect(candidates).to include apartment.renewal_fee
+          else
+            expect(apartment.renewal_fee).to be_nil
+          end
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: dummy-apartment
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Joe-noh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: This gem generates dummy information of apartment, including address,
   name, room number, geo and more.
 email:
@@ -60,8 +60,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -82,17 +82,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Generator of Japanese Apartment Dummy Data