i18n-wigodo 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 678e25416451af890b1e6a89bc11184a92e4ba782712ba6a77cdeabf36645579
-  data.tar.gz: bab9592b702e715ea8e2d64596428486f2b7709822f101c7e2272c939067a0b7
+  metadata.gz: 7572d4bfaa1d27de8e4a403a0f5afddba3a65721d0f190a4b418af138384f069
+  data.tar.gz: 132463a6c1afff1655005c997dbd756247dbe92a994f24b9eb4e8c7a91addcbd
 SHA512:
-  metadata.gz: 4bebd32cb1168779bd2e87d47e3760a26170afdb949155f0d24905b6bcf398983b0d860ce1cec3170e9a27ff9a798bbd18e4ca52cd38098aabefe99affddad60
-  data.tar.gz: cf3a7b8888c3a4448e90db0ffeb3cf1d5415a03068d435e79275707b2ed17a87a72d3eecaeff52567245e69b5d21d6bebecade806229d27b7ac6140cc585d740
+  metadata.gz: 89b983c7db48d0051c785979d5fb8c1de9263e422d28a5ca8b8b0b3abf109c751e5bd1484432fb9654842abbc935611bdd81e4e1973d5e7deee91a72ff6c0ce6
+  data.tar.gz: a5aca3a0bc7c61c054d5123586684c01d701b9b385ab92b68cdaada23f3f55966332ba953c6a166e0c55d0937b74df55098ab087ed5cef17edbb447182bf989b

data/CODE_OF_CONDUCT.md

@@ -1,74 +1,41 @@
-# Contributor Covenant Code of Conduct
+# Code of Conduct
 
-## Our Pledge
+## Philosophy
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+This project exists to make a positive impact on the world through collaborative effort. We believe that personal growth and technical excellence go hand in hand.
 
-## Our Standards
+## Core Principles
 
-Examples of behavior that contributes to creating a positive environment
-include:
+1. **Do No Harm**
+   We commit to avoiding actions that could harm the project or its community, whether through code, communications, or conduct.
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+2. **Practice Honesty**
+   We communicate truthfully and transparently about our work, capabilities, and challenges.
 
-Examples of unacceptable behavior by participants include:
+3. **Respect Resources**
+   We value and respect everyone's time, effort, and contributions. We take only what is freely given.
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+4. **Speak Mindfully**
+   We choose our words carefully, ensuring our communication is truthful, helpful, and constructive.
 
-## Our Responsibilities
+## Conflict Resolution
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+When conflicts arise, we:
+- Take responsibility for our own reactions and emotions
+- Use disagreements as opportunities for learning and growth
+- Focus on finding solutions rather than assigning blame
+- Practice equanimity in the face of criticism or disagreement
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+## Expectations
 
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
+Contributors agree to:
+- Contribute to the best of their ability
+- Accept that others will do the same
+- Focus on improving themselves rather than criticizing others
+- Work towards the common good of the project
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at malte.muenchert@gmx.net. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
+## Scope
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+This code applies to all project spaces, including issues, pull requests, discussions, and any project-related communications.
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+Remember: Your participation in this project is voluntary, and your contributions are appreciated. Let's work together to create something beneficial for all.

data/README.md

@@ -35,9 +35,63 @@ Or install it yourself as:
 
     $ gem install i18n-wigodo
 
+## Configuration
+
+The spreadsheet file is either identified by the URL or directly via the
+`document_id`.
+
+There is an [example file](https://docs.google.com/spreadsheets/d/1en5BoKGaAqO9_BRSQ9CQKkvwrYQWNBUPjgSzxyn83Pc/edit?gid=0#gid=0) showing how the columns should be laid out.
+The `document_id` of this file is the part between `d/` and `/edit`: `1en5BoKGaAqO9_BRSQ9CQKkvwrYQWNBUPjgSzxyn83Pc`.
+
+You have two options to set this:
+
+### Initializer (recommended)
+
+After the gem is loaded from a Rails app, you can use the install
+generator to create the initializer file:
+
+```sh
+bin/rails wigodo:install --url="https://docs.google.com/spreadsheets/d/1en5BoKGaAqO9_BRSQ9CQKkvwrYQWNBUPjgSzxyn83Pc/edit?gid=0#gid=0"
+```
+
+This will create `config/initializers/wigodo.rb` inside your Rails
+project and store the URL to the translations document.
+The `--url` parameter is optional, though.
+
+Alternatively, create the initializer file manually:
+
+Add `config/initializers/wigodo.rb`
+
+```Ruby
+I18nWigodo.configure do |config|
+  config.document_url = "https://docs.google.com/spreadsheets/d/1en5BoKGaAqO9_BRSQ9CQKkvwrYQWNBUPjgSzxyn83Pc/edit?gid=0#gid=0"
+
+  # Or just provide the document_id
+  # config.document_id = "1en5BoKGaAqO9_BRSQ9CQKkvwrYQWNBUPjgSzxyn83Pc"
+end
+```
+
+### YAML files (deprecated)
+
+Rails will read the config from `config/credentials.yml` or
+`config/secrets.yml`
+
+Add a key `wigodo_doc_id` containing the `document_id`.
+Just storing the URL directly is not supported with this method.
+
+Example:
+
+```yaml
+wigodo_doc_id: 1en5BoKGaAqO9_BRSQ9CQKkvwrYQWNBUPjgSzxyn83Pc
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+### 
+
+```sh
+rake wigodo:fetch
+```
 
 ## Development
 

data/i18n_wigodo.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 2.5"
+  spec.add_development_dependency "rake", "~> 13.2"
+  spec.add_development_dependency "rspec", "~> 3.13"
 end

data/lib/generators/i18n_wigodo/install_generator.rb

@@ -0,0 +1,18 @@
+require "rails/generators"
+
+module I18nWigodo
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    class_option :url, type: :string, default: nil, desc: "URL to translation spreadsheet (Google Docs) [optional]."
+
+    namespace "wigodo:install"
+
+    desc "Create initializer file for Wigodo (put the URL to your spreadsheet there)."
+    def create_initializer
+      @url = options[:url] || ''
+      template "initializer.rb.erb", "config/initializers/wigodo.rb"
+    end
+  end
+end
+

data/lib/generators/i18n_wigodo/templates/initializer.rb.erb

@@ -0,0 +1,3 @@
+I18nWigodo.configure do |config|
+  config.document_url = <%= @url.inspect %>
+end

data/lib/i18n_wigodo/configuration.rb

@@ -0,0 +1,36 @@
+module I18nWigodo
+  class Configuration
+    attr_accessor :document_id
+    attr_accessor :document_url
+
+    def initialize
+      id_from_credentials = Rails.application.credentials.wigodo_doc_id
+      id_from_secrets = Rails.application.respond_to?(:secrets) ? Rails.application.secrets.wigodo_doc_id : nil
+      @document_id = id_from_credentials || id_from_secrets
+    end
+
+    def get_document_id
+      if @document_url
+        if @document_url =~ /^https:\/\/docs\.google\.com\/spreadsheets\/d\//
+          @document_url.split('/')[5]
+        else
+          raise "Wigodo: document_url has an unexpected format #{@document_url}. It might help to update the gem (i18n-wigodo)."
+        end
+      else
+        if @document_id.present?
+          @document_id
+        else
+          nil
+        end
+      end
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/i18n_wigodo/tasks/wigodo.rake

@@ -17,18 +17,24 @@ end
 
 namespace :wigodo do
   desc 'Import translations from Google Drive'
-  task :fetch do
-    document_id = Rails.application.secrets.wigodo_doc_id || Rails.application.credentials.wigodo_doc_id
+  task fetch: :environment do
+    document_id = I18nWigodo.configuration.get_document_id
 
     unless document_id
-      abort("i18n-wigodo: wigodo_doc_id not set!\n" +
-            "Add the id of your Google Doc spreadsheet to\n" +
-            "config/credentials.yml (Rails < 5.2: config/secrets.yml).\n" +
-            "Use wigodo_doc_id as key.\n\n" +
-            "Example:\n\n" +
-            "wigodo_doc_id: 1en5BoKGaAqO9_BRSQ9CQKkvwrYQWNBUPjgSzxyn83Pc\n\n" +
-            "(This is the id of a sample document your can check out here:\n" +
-            "https://docs.google.com/spreadsheets/d/1en5BoKGaAqO9_BRSQ9CQKkvwrYQWNBUPjgSzxyn83Pc/edit#gid=0")
+      abort(<<~HELP
+              i18n-wigodo: document_url not set!
+
+              Get the URL to your spreadsheet.
+              Here is an example file:
+              https://docs.google.com/spreadsheets/d/1en5BoKGaAqO9_BRSQ9CQKkvwrYQWNBUPjgSzxyn83Pc/edit?gid=0#gid=0
+
+              Then, create an initializer in config/initializers/wigodo.rb like so:
+
+              I18nWigodo.configure do |config|
+                config.document_url = "(url to your Google Doc spreadsheet)"
+              end
+            HELP
+           )
     end
 
     resp = fetch_with_redirect("https://docs.google.com/spreadsheets/d/#{document_id}/export?format=csv")

data/lib/i18n_wigodo/version.rb

@@ -1,3 +1,3 @@
 module I18nWigodo
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/i18n_wigodo.rb

@@ -1,5 +1,7 @@
 require 'i18n_wigodo/version'
 require 'i18n_wigodo/railtie' if defined?(Rails)
+require 'i18n_wigodo/configuration'
+require 'generators/i18n_wigodo/install_generator'
 
 module I18nWigodo
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-wigodo
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Malte Münchert
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-02 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
 description: Adds a rake task to your Rails app that lets you fetch your translations
   from a Google Doc spreadsheet and convert it into YAML
 email:
@@ -71,8 +71,11 @@ files:
 - bin/console
 - bin/setup
 - i18n_wigodo.gemspec
+- lib/generators/i18n_wigodo/install_generator.rb
+- lib/generators/i18n_wigodo/templates/initializer.rb.erb
 - lib/i18n-wigodo.rb
 - lib/i18n_wigodo.rb
+- lib/i18n_wigodo/configuration.rb
 - lib/i18n_wigodo/railtie.rb
 - lib/i18n_wigodo/tasks/wigodo.rake
 - lib/i18n_wigodo/version.rb
@@ -81,7 +84,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,8 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Fetch translations from a Google Doc spreadsheet
 test_files: []