ffakerTW 0.1.0

data/Rakefile

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'rake'
+require 'date'
+
+require 'test/unit/testsuite'
+
+module Test
+  module Unit
+    class TestSuite
+      def run(result, &progress_block)
+        yield(STARTED, name)
+        run_startup(result)
+        @tests.each do |test|
+          test.run(result, &progress_block)
+          break unless result.passed?
+        end
+        run_shutdown(result)
+        yield(FINISHED, name)
+      end
+    end
+  end
+end
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{Regexp.last_match(1)}#{send(header_name)}'" }
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test/' << 'lib/'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+task default: :test
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort 'YARD is not available. In order to run yardoc, you must: sudo gem install yard'
+  end
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task release: :build do
+  unless `git branch` =~ /^\* main$/
+    puts 'You must be on the main branch to release!'
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh 'git push origin main'
+  sh 'git push --tags'
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task build: %i[gemspec reference] do
+  sh 'mkdir -p pkg'
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task gemspec: :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+
+  # determine file list from git ls-files
+  files = `git ls-files`
+          .split("\n")
+          .sort
+          .reject { |file| file =~ /^\./ }
+          .reject { |file| file =~ /^(rdoc|pkg)/ }
+          .map { |file| "    #{file}" }
+          .join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts 'A `VERSION` file at root level violates Gem best practices.'
+    exit!
+  end
+end
+
+desc 'Creates REFERENCE.md'
+task :reference do
+  system 'ruby ./scripts/reference.rb > REFERENCE.md'
+end

data/ffakerTW.gemspec

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "lib/ffakerTW/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ffakerTW"
+  spec.version = FfakerTW::VERSION
+  spec.authors = ["https://github.com/afgnsu/ffakerTW","Patrick Su"]
+  spec.email = ["afgnsu@gmail.com"]
+
+  spec.summary = "FfakerTW generates dummy data."
+  spec.description = "FfakerTW generates dummy data."
+  spec.homepage = "https://github.com/afgnsu/ffakerTW"
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.license = 'MIT'
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+  #spec.metadata["homepage_uri"] = spec.homepage
+  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.rdoc_options = ['--charset=UTF-8']
+  spec.extra_rdoc_files = %w[README.md LICENSE Changelog.md]
+
+  # = MANIFEST =
+  spec.files = %w[
+    Changelog.md
+    Gemfile
+    LICENSE
+    RANDOM.md
+    README.md
+    REFERENCE.md
+    Rakefile
+    ffakerTW.gemspec
+  ] + Dir['lib/**/*', 'scripts/*']
+  # = MANIFEST =
+
+  spec.test_files = Dir['test/**/*']
+
+  spec.metadata = {
+    'changelog_uri' => 'https://github.com/afgnsu/ffakerTW/blob/main/Changelog.md',
+    'documentation_uri' => 'https://github.com/afgnsu/ffakerTW/blob/main/REFERENCE.md'
+  }
+
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'test-unit'
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/ffakerTW/address.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module FFakerTW
+  module Address
+    extend ModuleUtils
+    extend self
+
+    COMPASS_DIRECTIONS = %w[North East West South].freeze
+    CITY_PREFIXES = COMPASS_DIRECTIONS + %w[New Lake Port]
+    SEC_ADDR = ['Apt. ###', 'Suite ###'].freeze
+
+    # @deprecated US specific address info. Moved into {AddressUS}
+    def zip_code
+      warn '[zip_code] is deprecated. For US addresses please use the AddressUS module'
+      FFakerTW::AddressUS.zip_code
+    end
+
+    def us_state
+      warn '[us_state] is deprecated. For US addresses please use the AddressUS module'
+      FFakerTW::AddressUS.state
+    end
+
+    def us_state_abbr
+      warn '[state_abbr] is deprecated. For US addresses please use the AddressUS module'
+      FFakerTW::AddressUS.state_abbr
+    end
+    # end US deprecation
+
+    def city_prefix
+      fetch_sample(CITY_PREFIXES)
+    end
+
+    def city_suffix
+      fetch_sample(CITY_SUFFIXES)
+    end
+
+    def city
+      case rand(0..3)
+      when 0 then format('%s %s%s', city_prefix, Name.first_name, city_suffix)
+      when 1 then format('%s %s', city_prefix, Name.first_name)
+      when 2 then format('%s%s', Name.first_name, city_suffix)
+      when 3 then format('%s%s', Name.last_name, city_suffix)
+      end
+    end
+
+    def street_suffix
+      fetch_sample(STREET_SUFFIX)
+    end
+
+    def building_number
+      FFakerTW.numerify(('#' * rand(3..5)))
+    end
+
+    def street_name
+      case rand(0..1)
+      when 0 then "#{Name.last_name} #{street_suffix}"
+      when 1 then "#{Name.first_name} #{street_suffix}"
+      end
+    end
+
+    def street_address(include_secondary = false)
+      str = +"#{building_number} #{street_name}"
+      str << " #{secondary_address}" if include_secondary
+      str
+    end
+
+    def secondary_address
+      FFakerTW.numerify(fetch_sample(SEC_ADDR))
+    end
+
+    # @deprecated UK specific address info. Moved into {AddressUK}
+    # UK Variants
+    def uk_county
+      warn '[uk_county] is deprecated. For UK addresses please use the AddressUK module'
+      FFakerTW::AddressUK.county
+    end
+
+    def uk_country
+      warn '[uk_country] is deprecated. For UK addresses please use the AddressUK module'
+      FFakerTW::AddressUK.country
+    end
+
+    def uk_postcode
+      warn '[uk_postcode] is deprecated. For UK addresses please use the AddressUK module'
+      FFakerTW::AddressUK.postcode
+    end
+    # end UK deprecation
+
+    def neighborhood
+      fetch_sample(NEIGHBORHOOD)
+    end
+
+    def country(given_code = nil)
+      country_index = COUNTRY_CODE.index(given_code)
+      if given_code && country_index
+        COUNTRY[country_index]
+      else
+        fetch_sample(COUNTRY)
+      end
+    end
+
+    def country_code(given_country = nil)
+      code_index = COUNTRY.index(given_country)
+      if given_country && code_index
+        COUNTRY_CODE[code_index]
+      else
+        fetch_sample(COUNTRY_CODE)
+      end
+    end
+
+    def time_zone
+      fetch_sample(TIME_ZONE)
+    end
+  end
+end

data/lib/ffakerTW/address_au.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require_relative 'address'
+
+module FFakerTW
+  module AddressAU
+    include FFakerTW::Address
+
+    extend ModuleUtils
+    extend self
+
+    # based on areas labeled state (+act) here:
+    # http://en.wikipedia.org/wiki/States_and_territories_of_Australia
+    STATE = [
+      'Australian Capital Territory', 'New South Wales', 'Queensland',
+      'South Australia', 'Tasmania', 'Victoria', 'Western Australia'
+    ].freeze
+    STATE_ABBR = %w[ACT NSW NT QLD SA TAS VIC WA].freeze
+    # based on http://en.wikipedia.org/wiki/List_of_cities_in_Australia
+    SUBURB = {
+      'ACT' => {
+        '2600' => 'Canberra', '2601' => 'Canberra', '2602' => "O'Connor", '2612' => 'Braddon'
+      },
+      'NT' => { '0800' => 'Darwin', '0830' => 'Palmerston' },
+      'SA' => {
+        '5000' => 'Adelaide', '5015' => 'Port Adelaide', '5211' => 'Victor Harbor',
+        '5251' => 'Mount Barker', '5253' => 'Murray Bridge', '5254' => 'Murray Bridge',
+        '5290' => 'Mount Gambier', '5291' => 'Mount Gambier', '5540' => 'Port Pirie',
+        '5600' => 'Whyalla', '5606' => 'Port Lincoln', '5607' => 'Port Lincoln',
+        '5700' => 'Port Augusta', '5710' => 'Port Augusta'
+      },
+      'WA' => {
+        '6000' => 'Perth', '6008' => 'Subiaco', '6009' => 'Nedlands',
+        '6021' => 'Stirling', '6027' => 'Joondalup', '6053' => 'Bayswater',
+        '6065' => 'Wanneroo', '6110' => 'Gosnells', '6112' => 'Armadale',
+        '6151' => 'South Perth', '6156' => 'Melville', '6160' => 'Fremantle',
+        '6168' => 'Rockingham', '6210' => 'Mandurah', '6230' => 'Bunbury',
+        '6330' => 'Albany', '6430' => 'Kalgoorlie', '6530' => 'Geraldton'
+      },
+      'NSW' => {
+        '2000' => 'Sydney', '2031' => 'Randwick', '2046' => 'Canada Bay',
+        '2068' => 'Willoughby', '2112' => 'Ryde', '2142' => 'Holroyd',
+        '2148' => 'Blacktown', '2150' => 'Parramatta', '2165' => 'Fairfield',
+        '2170' => 'Liverpool', '2193' => 'Canterbury', '2200' => 'Bankstown',
+        '2216' => 'Rockdale', '2220' => 'Hurstville', '2250' => 'Gosford',
+        '2300' => 'Newcastle', '2320' => 'Maitland', '2325' => 'Cessnock',
+        '2340' => 'Tamworth', '2350' => 'Armidale', '2450' => 'Coffs Harbour',
+        '2460' => 'Grafton', '2480' => 'Lismore', '2500' => 'Wollongong',
+        '2529' => 'Shellharbour', '2560' => 'Campbelltown', '2580' => 'Goulburn',
+        '2620' => 'Queanbeyan', '2640' => 'Albury', '2650' => 'Wagga Wagga',
+        '2680' => 'Griffith', '2750' => 'Penrith', '2790' => 'Lithgow',
+        '2795' => 'Bathurst', '2800' => 'Orange', '2830' => 'Dubbo',
+        '2880' => 'Broken Hill'
+      },
+      'QLD' => {
+        '4000' => 'Brisbane', '4217' => 'Surfers Paradise', '4305' => 'Ipswich',
+        '4350' => 'Toowoomba', '4370' => 'Warwick', '4551' => 'Caloundra',
+        '4570' => 'Gympie', '4650' => 'Maryborough', '4655' => 'Hervey Bay',
+        '4670' => 'Bundaberg', '4680' => 'Gladstone', '4700' => 'Rockhampton',
+        '4740' => 'Mackay', '4810' => 'Townsville', '4820' => 'Charters Towers',
+        '4825' => 'Mount Isa', '4870' => 'Cairns'
+      },
+      'VIC' => {
+        '3000' => 'Melbourne', '3175' => 'Dandenong', '3199' => 'Frankston',
+        '3220' => 'Geelong', '3280' => 'Warrnambool', '3300' => 'Hamilton',
+        '3337' => 'Melton', '3350' => 'Ballarat', '3377' => 'Ararat',
+        '3400' => 'Horsham', '3500' => 'Mildura', '3550' => 'Bendigo',
+        '3585' => 'Swan Hill', '3630' => 'Shepparton', '3672' => 'Benalla',
+        '3677' => 'Wangaratta', '3690' => 'Wodonga', '3825' => 'Moe',
+        '3840' => 'Morwell', '3844' => 'Traralgon', '3850' => 'Sale',
+        '3875' => 'Bairnsdale'
+      },
+      'TAS' => {
+        '7000' => 'Hobart', '7010' => 'Glenorchy', '7250' => 'Launceston',
+        '7310' => 'Devonport', '7320' => 'Burnie'
+      }
+    }.freeze
+    POSTCODE = SUBURB.inject({}) { |h, (s_abbr, postcode_suburb_map)| h.update(s_abbr => postcode_suburb_map.keys) }
+    TIME_ZONE = {
+      'ACT' => 'Australia/Canberra',
+      'NT' => 'Australia/Darwin',
+      'SA' => 'Australia/Adelaide',
+      'WA' => 'Australia/Perth',
+      'NSW' => 'Australia/Sydney',
+      'QLD' => 'Australia/Brisbane',
+      'VIC' => 'Australia/Melbourne',
+      'TAS' => 'Australia/Hobart'
+    }.freeze
+
+    def postcode(st_abbr = nil)
+      st_abbr ||= state_abbr
+      POSTCODE[st_abbr][rand(0...POSTCODE[st_abbr].size)]
+    end
+
+    def state
+      fetch_sample(STATE)
+    end
+
+    def state_abbr
+      fetch_sample(STATE_ABBR)
+    end
+
+    def suburb(st_abbr = nil, p_code = nil)
+      st_abbr ||= state_abbr
+      p_code ||= postcode(st_abbr)
+      SUBURB[st_abbr][p_code]
+    end
+
+    def full_address(st_abbr = nil)
+      st_abbr ||= state_abbr
+      "#{FFakerTW::Address.street_address}, #{suburb(st_abbr)} #{st_abbr} #{postcode}"
+    end
+
+    def time_zone(st_abbr = nil)
+      return TIME_ZONE[st_abbr] if st_abbr
+
+      TIME_ZONE.values.sample
+    end
+  end
+end

data/lib/ffakerTW/address_br.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'address'
+
+module FFakerTW
+  module AddressBR
+    include FFakerTW::Address
+
+    extend ModuleUtils
+    extend self
+
+    STREET_PREFIX = %w[Rua Avenida Travessa Alameda].freeze
+
+    def zip_code
+      FFakerTW.numerify '#####-###'
+    end
+
+    def state
+      fetch_sample(STATE)
+    end
+
+    def state_abbr
+      fetch_sample(STATE_ABBR)
+    end
+
+    def city
+      fetch_sample(CITY)
+    end
+
+    def street_prefix
+      fetch_sample(STREET_PREFIX)
+    end
+
+    def street
+      case rand(0..1)
+      when 0 then "#{street_prefix} #{NameBR.name}"
+      when 1 then "#{street_prefix} #{NameBR.first_name} #{NameBR.last_name} #{NameBR.last_name}"
+      end
+    end
+
+    def complement
+      FFakerTW.numerify(fetch_sample(COMPLEMENT))
+    end
+
+    def neighborhood
+      prefix = fetch_sample(NEIGHBORHOOD_PREFIXES)
+      "#{prefix} #{NameBR.first_name}"
+    end
+
+    def full_address(with_complement: false)
+      base_address_order = [street, building_number, neighborhood, city, state, 'Brazil']
+      return base_address_order.join(', ') unless with_complement
+
+      base_address_order.insert(2, complement).join(', ')
+    end
+  end
+end

data/lib/ffakerTW/address_ca.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'address'
+
+module FFakerTW
+  module AddressCA
+    include FFakerTW::Address
+
+    extend ModuleUtils
+    extend self
+
+    POSTAL_CODE_FORMAT = '?#? #?#'
+    POSTAL_CODE_CHARS = %w[A B C E G H J K L M N P R S T V X Y].freeze
+    PROVINCE_ABBRS = %w[NL NS PE NB QC ON MB SK AB BC YT NT NU].freeze
+
+    def postal_code
+      FFakerTW.numerify(POSTAL_CODE_FORMAT.gsub('?') { fetch_sample(POSTAL_CODE_CHARS) })
+    end
+
+    def province
+      fetch_sample(PROVINCE)
+    end
+
+    def city
+      fetch_sample(CITY)
+    end
+
+    def province_abbr
+      fetch_sample(PROVINCE_ABBRS)
+    end
+  end
+end

data/lib/ffakerTW/address_ch.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FFakerTW
+  module AddressCH
+    include FFakerTW::Address
+
+    extend ModuleUtils
+    extend self
+
+    def postal_code
+      FFakerTW.numerify '####'
+    end
+
+    def canton_abbr
+      fetch_sample(CANTON_ABBR)
+    end
+  end
+end

data/lib/ffakerTW/address_ch_de.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FFakerTW
+  module AddressCHDE
+    include AddressCH
+
+    extend ModuleUtils
+    extend self
+
+    def canton
+      fetch_sample(CANTON)
+    end
+  end
+end

data/lib/ffakerTW/address_ch_fr.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FFakerTW
+  module AddressCHFR
+    include AddressCH
+
+    extend ModuleUtils
+    extend self
+
+    def canton
+      fetch_sample(CANTON)
+    end
+  end
+end

data/lib/ffakerTW/address_ch_it.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FFakerTW
+  module AddressCHIT
+    include AddressCH
+
+    extend ModuleUtils
+    extend self
+
+    def canton
+      fetch_sample(CANTON)
+    end
+  end
+end

data/lib/ffakerTW/address_da.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module FFakerTW
+  module AddressDA
+    include FFakerTW::Address
+
+    extend ModuleUtils
+    extend self
+
+    REGION = %w[Hovedstaden Sjælland Syddanmark Midtjylland Nordjylland].freeze
+    STATE = REGION
+
+    def zip_code
+      FFakerTW.numerify('####')
+    end
+
+    def post_nr
+      zip_code
+    end
+
+    def state
+      kommune
+    end
+
+    def kommune
+      fetch_sample(KOMMUNE)
+    end
+
+    def region
+      fetch_sample(REGION)
+    end
+
+    def city
+      fetch_sample(CITY)
+    end
+
+    def street_name
+      fetch_sample(STREET)
+    end
+
+    def street_address
+      "#{street_name} #{rand(0..99)}"
+    end
+
+    def full_address
+      "#{street_address} #{post_nr} #{city} #{region} DANMARK"
+    end
+  end
+end