flag_icon 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb275d7c19f1435cf9531f4d7aafce60d773c743a255b36e3aac91245b74a507
-  data.tar.gz: 6a7a47c3c911a5e1b97d21884c2a0486a1f58c8dafde04dc88690a1be5e8a8aa
+  metadata.gz: a681cfb4be4dd25f03cf0fa2f036764b178f3ef23a0d394d86f3cf4ef49a5af1
+  data.tar.gz: 2e70a4e0530292e43f787b25c0df6b9711c03a370013d52d4fd5bdc0278d1903
 SHA512:
-  metadata.gz: f0aaab933540e278cbb15aec7b154f860153eeb04b741ebf62736dc24b59743e0c5a7bfc5bf6c809b7d133e307d214e567bfbd07945eead37da2a7ef13ab6a24
-  data.tar.gz: 7097374454799947115f3bb6b6644b11746e725b73044f220e01e7a736334fda7ab7c6d28c4a3f1caa8d603f1347c9cf20130d2fea3d432f059509d0b4d2485e
+  metadata.gz: f752bd8917b096e03085653d41447d6993177453d7851e2959a2b73f3a346b55687d9b146bde7ceb951aadac5542a736763e4089100f65912ea149192f09a99a
+  data.tar.gz: 662475aff393e6c27e455a382fcd63a682f08d24b55208ddb9049ca2a58bfa06c14656943d6f9d90370e5397df53d90836a8ca5d04a37cd6cef0d8fc5fde9b9c

data/.github/workflows/main.yml

@@ -1,25 +1,22 @@
-name: Ruby
+name: Run tests
 
 on:
   push:
     branches:
-      - main
+      - '*'
+      - '!master'
+
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        ruby:
-          - 3.0.3
-
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ matrix.ruby }}
+        ruby-version: 3.0.3
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish Gem
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.3
+          bundler-cache: true
+      - name: Run the default task
+        run: bundle exec rake
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build flag_icon.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+3.0.3

data/Gemfile

@@ -2,5 +2,7 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
+ruby '3.0.3'
+
 # Specify your gem's dependencies in flag_icon.gemspec
 gemspec

data/Gemfile.lock

@@ -1,13 +1,122 @@
 PATH
   remote: .
   specs:
-    flag_icon (1.1.1)
+    flag_icon (1.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
     diff-lcs (1.5.0)
     docile (1.4.0)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.13.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.15.0)
+    nio4r (2.5.8)
+    nokogiri (1.13.0-x86_64-linux)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
     rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -28,15 +137,33 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   flag_icon!
+  rails (~> 6.1)
   rake (~> 13.0)
   rspec (~> 3.0)
-  simplecov
+  simplecov (~> 0.21)
+
+RUBY VERSION
+   ruby 3.0.3p157
 
 BUNDLED WITH
-   2.2.22
+   2.2.32

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 TODO: Write your name
+Copyright (c) 2022 Movie buff
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,6 @@
 # FlagIcon
+An attempt to map languages to flags!
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/flag_icon`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -21,18 +19,94 @@ Or install it yourself as:
     $ gem install flag_icon
 
 ## Usage
+There is a number of helpers available that will render country names, language names and flags given a country code or locale.
 
-TODO: Write usage instructions here
+```ruby
+# It returns HTML element with country icon and title
+#
+# @param code -> language locale
+# @example language_icon('el')
+# @return String
+language_icon
+```
+```ruby
+# It returns HTML element with country icon
+#
+# @param code -> country iso code
+# @example flag_icon('gr')
+# @return String
+flag_icon
+```
+```ruby
+# It returns the language name
+#
+# @param code -> language locale
+# @example language_name('el') # => Greek
+# @return String
+language_name
+```
+```ruby
+# It returns the country name
+#
+# @param code -> country iso code
+# @example language_name('gr') # => Greece
+# @return String
+country_name
+```
+```ruby
+# It returns the country iso code
+#
+# @param code -> language locale
+# @example language_name('el') # => gr
+# @return String
+language_flag
+```
+```ruby
+# It returns the country iso code
+#
+# @param popular -> title of the popular group
+# @param available -> title of the available group
+# @example select_language
+# @return Hash
+select_language
+```
+```ruby
+# Define in your application_helper to override the popular languages
+# Default: [['English', :en], ['Spanish', :es]]
+#
+# @example
+#   def popular_languages
+#     [['English', :en], ['Spanish', :es]]
+#   end
+# @return Array
+popular_languages
+```
+```ruby
+# Define in your application_helper to override the available languages
+# @example [['English', :en], ['Spanish', :es]] #default
+# @example
+#   def available_languages
+#     Language.all.order(:language_locale).pluck(:language_locale)
+#   end
+# @return Array
+available_languages
 
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
+Matching flags to languages can be really tricky and even problematic sometimes because there is no direct association 
+between languages and countries since the same language is spoken in many countries and many languages are spoken in a single. 
+So a effort was made to identify the official language of each country and then assign the flag to the language not the country.
+
+So for a title from Mexico which has spanish as the official language the spanish flag will appear.
+
+Therefore if you notice any flags being mismatched please raise an [issue](https://github.com/alexwebgr/flag_icon/issues) 
+or even better open a [pull request](https://github.com/alexwebgr/flag_icon/pulls)
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/flag_icon. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/flag_icon/blob/master/CODE_OF_CONDUCT.md).
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/alexwebgr/flag_icon/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +114,11 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the FlagIcon project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/flag_icon/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the FlagIcon project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alexwebgr/flag_icon/blob/master/CODE_OF_CONDUCT.md).
+
+## Credits
+* Flag icons and css from [flag-icons](https://github.com/lipis/flag-icons)
+* Country names [xqisocodes.html](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
+* Language to country mapping [country_locale_map.json](https://github.com/riboseinc/country_to_locales_mapping/blob/master/data/country_locale_map.json)
+* Language to country mapping [language-identifiers.html](http://www.i18nguy.com/unicode/language-identifiers.html)
+

data/flag_icon.gemspec

@@ -28,7 +28,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib", '"vendor"']
 
+  spec.add_development_dependency "rails", "~> 6.1"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov", "~> 0.21"
 end

data/lib/flag_icon/helpers.rb

@@ -0,0 +1,93 @@
+module FlagIcon
+  # It returns the language name
+  #
+  # @param code -> language locale
+  # @example language_name('el') # => Greek
+  # @return String
+  def language_name(code)
+    FlagIcon::Countries::LANGUAGES[code.to_sym]
+  end
+
+  # It returns the country name
+  #
+  # @param code -> country iso code
+  # @example language_name('gr') # => Greece
+  # @return String
+  def country_name(code)
+    FlagIcon::Countries::NAMES[code.to_sym]
+  end
+
+  # It returns the country iso code
+  #
+  # @param code -> language locale
+  # @example language_name('el') # => gr
+  # @return String
+  def language_flag(code)
+    FlagIcon::Countries::LANGUAGE_FLAGS[code.to_sym]
+  end
+
+  # It returns the country iso code
+  #
+  # @param popular -> title of the popular group
+  # @param available -> title of the available group
+  # @example select_language
+  # @return Hash
+  def select_language(popular = 'Popular', available = 'Available')
+    {
+      popular => popular_languages,
+      available => available_languages.map { |lang| [language_name(lang), lang] }
+    }
+  end
+
+
+  # It returns HTML element with country icon and title
+  #
+  # @param code -> language locale
+  # @example language_icon('el')
+  # @return String
+  def language_icon(code)
+    "<span class='flag-icon flag-icon-#{language_flag(code)}' title='Audio language - #{language_name(code)}'></span>"
+  end
+
+  # It returns HTML element with country icon
+  #
+  # @param code -> country iso code
+  # @example flag_icon('gr')
+  # @return String
+  def flag_icon(code)
+    "<span class='flag-icon flag-icon-#{code}' title='Available in #{country_name(code)}'></span>"
+  end
+
+  # Define in your application_helper to override the popular languages
+  # Default: [['English', :en], ['Spanish', :es]]
+  #
+  # @example
+  #   def popular_languages
+  #     [['English', :en], ['Spanish', :es]]
+  #   end
+  # @return Array
+  def popular_languages
+    [['English', :en], ['Spanish', :es]]
+  end
+
+  # Define in your application_helper to override the available languages
+  # @example [['English', :en], ['Spanish', :es]] #default
+  # @example
+  #   def available_languages
+  #     Language.all.order(:language_locale).pluck(:language_locale)
+  #   end
+  # @return Array
+  def available_languages
+    @languages ||= FlagIcon::Countries::LANGUAGES.keys
+  end
+
+  # exposed methods for testing
+  module_function :language_name
+  module_function :country_name
+  module_function :language_flag
+  module_function :select_language
+  module_function :language_icon
+  module_function :flag_icon
+  module_function :popular_languages
+  module_function :available_languages
+end

data/lib/flag_icon/rails/version.rb

@@ -1,5 +1,5 @@
 module FlagIcon
   module Rails
-    VERSION = "1.0.0"
+    VERSION = "1.3.0"
   end
 end

data/lib/flag_icon/railtie.rb

@@ -1,9 +1,9 @@
 require 'rails'
-require "flag_icon/helper"
+require "flag_icon/helpers"
 
 module FlagIcon
   class Railtie < ::Rails::Railtie
-    initializer "flag_icon.helper" do
+    initializer "flag_icon.helpers" do
       ActionView::Base.send :include, FlagIcon
     end
   end

data/lib/flag_icon.rb

@@ -1,4 +1,7 @@
-require "flag_icon/helper"
+require "flag_icon/helpers"
 require "flag_icon/countries"
 require "flag_icon/railtie"
 require 'flag_icon/rails'
+
+module FlagIcon
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: flag_icon
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - alexwebgr
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +56,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
 description: A gem that contains view helpers for language names, country names and
   language to flags
 email:
@@ -61,8 +75,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -72,7 +88,7 @@ files:
 - flag_icon.gemspec
 - lib/flag_icon.rb
 - lib/flag_icon/countries.rb
-- lib/flag_icon/helper.rb
+- lib/flag_icon/helpers.rb
 - lib/flag_icon/rails.rb
 - lib/flag_icon/rails/engine.rb
 - lib/flag_icon/rails/version.rb
@@ -360,7 +376,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/alexwebgr/flag_icon
   source_code_uri: https://github.com/alexwebgr/flag_icon
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -376,8 +392,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.2.32
+signing_key: 
 specification_version: 4
 summary: An attempt to map languages to country flags
 test_files: []

data/lib/flag_icon/helper.rb

@@ -1,40 +0,0 @@
-module FlagIcon
-  private
-
-  def language_name(code)
-    FlagIcon::Countries::LANGUAGES[code.to_sym]
-  end
-
-  def country_name(code)
-    FlagIcon::Countries::NAMES[code.to_sym]
-  end
-
-  def language_flag(code)
-    FlagIcon::Countries::LANGUAGE_FLAGS[code.to_sym]
-  end
-
-  def select_language
-    {
-      'Popular' => popular_languages,
-      'Available' => available_languages.map { |lang| [language_name(lang), lang] }
-    }
-  end
-
-  def language_icon(code)
-    "<span class='flag-icon flag-icon-#{language_flag(code)}' title='Audio language - #{language_name(code)}'></span>"
-  end
-
-  def flag_icon(code)
-    "<span class='flag-icon flag-icon-#{code}' title='Available in #{country_name(code)}'></span>"
-  end
-
-  public
-
-  def popular_languages
-    [['English', :en], ['Spanish', :es]]
-  end
-
-  def available_languages
-    @languages ||= FlagIcon::Countries::LANGUAGES.keys
-  end
-end