geekdict 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 584fbc9ba64e0e69f1a8cc5a55660b2b9d5a6b229d560972da8abd88a582f778
-  data.tar.gz: 74ddd2908ffb00c437bae03b479953d495b8f798766ba2a27519695463352c41
+  metadata.gz: 8c60ec472c37345eac7c1b4be1f60c56ea5edca02c3c5af8eb19be3cd1173470
+  data.tar.gz: ada5e008be1245e52e1b70827b7ef517f067ce187a3a7c755d97e45c189cb14d
 SHA512:
-  metadata.gz: fa89f1efbaa00051e2ad0da3f5c3963207ae3e20023d43e6afff705ea878b2aa61b42cbe050729811e2325744fe98679b289e93ec5dd6652fcf4514d75d2b988
-  data.tar.gz: 5e0548e8bbad29b21f6a5cfd2cda6acf438aac5092d15f6d3baec9fa606fe9ca6bcbb503bdb39782e118fc4d36e58c0ab8daa6d5449a43f154ef15a87fcc79c1
+  metadata.gz: 06ae16f269a32062b8d825debf6e4f76df6cf9e65394365c8275dd0846d163bcaa70203d39561695c6744ae9e137364d6cd2b2ce4d2ee9bb59df492bed357022
+  data.tar.gz: e29388ec6089b5172b6898f805942150c8862e0b909ba0dbc37ee4e2d3835b89d190128e6824b19bef7905174dcd8b1c7654f6b3debc176d9e72536fc1be100f

data/README.md

@@ -12,57 +12,130 @@ You can install via rubygems:
 
 Configure
 --------
-GeekDict supports multiple translation providers:
+GeekDict requires API keys for certain providers, set as environment variables:
 
-1. **OpenRouter** (default): Uses the openai/o3-mini model through OpenRouter. Set the `OPENROUTER_API_KEY` environment variable.
-2. **OpenAI**: Uses OpenAI's GPT-3.5. Set the `OPENAI_API_KEY` environment variable.
-3. **Youdao**: Uses Youdao translation API. Configure in `~/.geekdict.yml`.
+*   **OpenRouter**: Set `OPENROUTER_API_KEY`.
+*   **OpenAI**: Set `OPENAI_API_KEY`.
+*   **Youdao**: Configuration for Youdao keys is typically handled within its specific module or a separate config file if needed (refer to Youdao provider specifics if used).
+
+### Configuration File (Optional)
+
+You can customize the default provider and model by creating a configuration file at `~/.geekdict.config`. The file should be in YAML format.
+
+**Example `~/.geekdict.config`:**
+
+```yaml
+provider: openrouter # 'openai', 'openrouter', or 'youdao'
+model: google/gemini-2.5-flash-preview # Specific model for the chosen provider
+```
+
+**Defaults:**
+
+*   If the config file is not present or a setting is missing, the tool defaults to:
+    *   `provider: openrouter`
+    *   `model: google/gemini-2.5-flash-preview`
+
+**Prioritization:**
+
+Settings are applied in the following order (highest priority first):
+
+1.  Command-line options (`--provider`, `--model`)
+2.  Values in `~/.geekdict.config`
+3.  Hardcoded defaults
 
 
 Commands
 --------
-### Translate a word
-
-	# Using the default OpenRouter provider
-	$geekdict t test
-	
-	# Specify a provider
-	$geekdict t test -p openai
-	$geekdict t test --provider=youdao
-	
-	# Example output
-	测试 (cè shì)
-
-	Explanation:
-	The word "测试" in Chinese means "test" in English. It refers to the process of evaluating or examining something to determine its quality, performance, or knowledge. It can be used in various contexts, such as academic exams, software testing, or product quality testing.
-	
-	Example:
-	1. 我们明天有一场数学测试。
-	We have a math test tomorrow.
-	
-	2. 这个软件需要经过严格的测试才能发布。
-	This software needs to undergo rigorous testing before it can be released.
+### Translate a word (`t`)
+
+Translates a given word between English and Chinese.
+
+**Usage:**
+
+```bash
+geekdict t [options] <word>
+```
+
+**Options:**
+
+*   `-p, --provider PROVIDER`: Specify the translation provider (`openai`, `openrouter`, `youdao`). Overrides config file setting.
+*   `-m, --model MODEL`: Specify the LLM model to use (e.g., `gpt-4`, `google/gemini-pro`). Overrides config file setting.
+*   `-d, --debug`: Enable debug output.
+*   `-o, --open`: (Functionality might vary - check specific provider usage)
+
+**Examples:**
+
+```bash
+# Use defaults (provider/model from CLI -> config -> hardcoded defaults)
+$ geekdict t hello
+
+# Specify provider (uses default/config model for that provider)
+$ geekdict t hello -p openai
+
+# Specify model (uses default/config provider)
+$ geekdict t hello -m gpt-4
+
+# Specify both provider and model
+$ geekdict t hello --provider openrouter --model anthropic/claude-3-haiku
+
+# Use Youdao provider (model option typically ignored)
+$ geekdict t hello -p youdao
+```
+
+**Example Output (using an LLM provider):**
+
+```
+Translation: 你好 (nǐ hǎo)
+
+Explanation:
+"你好" (nǐ hǎo) is the standard Mandarin Chinese greeting equivalent to "hello" in English. It's a polite and common way to greet someone.
+
+Examples:
+1. 你好，请问有什么可以帮您的吗？
+   Hello, may I help you with anything?
+2. 他笑着对我说你好。
+   He smiled and said hello to me.
+```
 
 Command Help
 ------------
-Use *help* command to get detail information.
+Use the `help` command to get detailed information about commands and options.
 
-	$geekdict
-	Commands:
-	  geekdict help [COMMAND]  # Describe available commands or one specific command
-	  geekdict t               # Translate a word
+```bash
+$ geekdict help
+Commands:
+  geekdict help [COMMAND]  # Describe available commands or one specific command
+  geekdict t <word>        # Translate a word
+  geekdict v               # Show version
 
-	$geekdict help t
-	Usage:
-	  geekdict t
+$ geekdict help t
+Usage:
+  geekdict t [options] <word>
 
-	Options:
+Options:
   -d, [--debug], [--no-debug]
   -o, [--open], [--no-open]
-  -p, [--provider=PROVIDER]      # Translation provider to use (openrouter, openai, youdao)
+  -p, [--provider=PROVIDER]              # Provider (overrides config: openai/openrouter/youdao)
+  -m, [--model=MODEL]                    # LLM model (overrides config)
+                                         # Default: false
+
+Translate a word
+```
+
+### Shell Alias (Optional)
 
-	Translate a word
+For faster access, you can create a shell alias. Add the following line to your shell configuration file (e.g., `~/.bashrc`, `~/.zshrc`):
 
+```bash
+alias t='geekdict t'
+```
+
+After adding the alias and restarting your shell or sourcing the configuration file (e.g., `source ~/.zshrc`), you can simply use `t` instead of `geekdict t`:
+
+```bash
+# Instead of: geekdict t hello
+t hello
+```
 
 Development
 ----------

data/lib/geekdict/cli.rb

@@ -1,35 +1,69 @@
 require "thor"
+# Remove YAML require, handled in config.rb
 require_relative 'local_history'
 require_relative 'version'
+require_relative 'config' # Add require for the new config module
 require_relative 'openai/gpt.rb'
 require_relative 'openrouter/api.rb'
+# Assuming youdao might be added later or is handled elsewhere
+# require_relative 'youdao/api.rb'
+require_relative 'youdao/api.rb' # Keep youdao require
 
 module GeekDict
+  class CLI < Thor
+    # Constants and load_config are now in GeekDict::Config
 
-    class CLI < Thor
-
-        desc "t", "Translate a word"
-        option :debug, :aliases=>'-d', :type=>:boolean, :default=>false
-        option :open, :aliases=>'-o', :type=>:boolean, :default=>false
-        option :provider, :aliases=>'-p', :type=>:string, :default=>'openrouter', :enum=>['openai', 'openrouter', 'youdao'], :desc=>"Translation provider to use"
-        def t(word)
-            GeekDict.debugger options[:debug]
-            LocalHistory.save word
-            
-            provider = options[:provider].downcase
-            result = case provider
-                     when 'openai'
-                       GeekDict::OpenAI.translate(word)
-                     when 'openrouter'
-                       GeekDict::OpenRouter.translate(word)
-                     when 'youdao'
-                       GeekDict::Youdao.translate(word)
-                     else
-                       GeekDict::OpenRouter.translate(word)
-                     end
-            
-            puts result
-        end
+    desc "t", "Translate a word"
+    option :debug, :aliases => '-d', :type => :boolean, :default => false
+    option :open, :aliases => '-o', :type => :boolean, :default => false
+    # Update enum and desc to use Config constants
+    option :provider, :aliases => '-p', :type => :string, :enum => GeekDict::Config::ALLOWED_PROVIDERS, :desc => "Provider (overrides config: #{GeekDict::Config::ALLOWED_PROVIDERS.join('/')})"
+    # Add model option
+    option :model, :aliases => '-m', :type => :string, :desc => "LLM model (overrides config)"
+    def t(word)
+      GeekDict.debugger options[:debug]
+      LocalHistory.save word
+
+      # 1. Load config file using the Config module
+      config = GeekDict::Config.load_config
+
+      # 2. Determine provider: CLI option > Config file > Default (use Config constants)
+      provider = options[:provider]&.downcase || config[:provider] || GeekDict::Config::DEFAULT_PROVIDER
+
+      # 3. Determine model: CLI option > Config file > Default (use Config constants)
+      model = options[:model] || config[:model] || GeekDict::Config::DEFAULT_MODEL
+
+      # 4. Validate provider (use Config constants)
+      unless GeekDict::Config::ALLOWED_PROVIDERS.include?(provider)
+        warn "Warning: Invalid provider '#{provider}' specified. Using default '#{GeekDict::Config::DEFAULT_PROVIDER}'."
+        provider = GeekDict::Config::DEFAULT_PROVIDER
+        # Reset model if provider changed to default, unless model was explicitly set via CLI
+        model = options[:model] || GeekDict::Config::DEFAULT_MODEL # Use default model for the default provider
+      end
+
+      # Optional: Output effective settings for debugging/clarity
+      puts "Using provider: #{provider}, model: #{model}" if options[:debug]
+
+      # 5. Call the appropriate provider with the word and model
+      result = case provider
+               when 'openai'
+                 # TODO: Update OpenAI class to accept model
+                 GeekDict::OpenAI.translate(word, model: model)
+               when 'openrouter'
+                 # TODO: Update OpenRouter class to accept model
+                 GeekDict::OpenRouter.translate(word, model: model)
+               when 'youdao'
+                 # Youdao might not use a 'model' in the same way.
+                 # If it needs config, adjust here. For now, pass nothing extra.
+                 GeekDict::Youdao.translate(word)
+               else
+                 # This case should technically not be reached due to validation
+                 warn "Internal Error: Unknown provider '#{provider}'. Aborting."
+                 exit 1
+               end
+
+      puts result
+    end
 
         desc "v", "version"
         def v()

data/lib/geekdict/config.rb

@@ -0,0 +1,33 @@
+require "yaml"
+
+module GeekDict
+  module Config
+    CONFIG_PATH = File.expand_path("~/.geekdict.config")
+    DEFAULT_PROVIDER = "openrouter"
+    DEFAULT_MODEL = "google/gemini-2.5-flash-preview"
+    ALLOWED_PROVIDERS = ['openai', 'openrouter', 'youdao'].freeze
+
+    module_function
+
+    # Method to load configuration from ~/.geekdict.config
+    def load_config
+      config = {}
+      if File.exist?(CONFIG_PATH)
+        begin
+          loaded_config = YAML.load_file(CONFIG_PATH)
+          config = loaded_config if loaded_config.is_a?(Hash)
+        rescue Psych::SyntaxError => e
+          warn "Warning: Error parsing config file #{CONFIG_PATH}: #{e.message}. Using defaults."
+        rescue => e
+          warn "Warning: Could not load config file #{CONFIG_PATH}: #{e.message}. Using defaults."
+        end
+      end
+      # Ensure keys are symbols for easier access, handle potential nil values
+      config = config.transform_keys { |k| k.to_s.downcase.to_sym rescue k } # Make keys symbols & lowercase
+      {
+        provider: config[:provider],
+        model: config[:model]
+      }
+    end
+  end
+end

data/lib/geekdict/openai/gpt.rb

@@ -8,12 +8,16 @@ module GeekDict
 
 		module_function
 
-		def translate(word)
+    # Update translate method to accept model
+		def translate(word, model: nil) # Add model keyword argument
 			@debugger = GeekDict.debugger
+      # Use the provided model, or fallback to a default if nil
+      effective_model = model || "gpt-3.5-turbo" # Fallback model for OpenAI
+
 			client = ::OpenAI::Client.new(access_token: ENV.fetch('OPENAI_API_KEY'))
       response = client.chat(
         parameters: {
-          model: "gpt-3.5-turbo",
+          model: effective_model, # Use the determined model
           messages: [
             { role: "system", content: system_prompt(word)},
             { role: "user", content: word}

data/lib/geekdict/openrouter/api.rb

@@ -5,9 +5,13 @@ module GeekDict
   module OpenRouter
     module_function
 
-    def translate(word)
+    # Update translate method to accept model
+    def translate(word, model: nil) # Add model keyword argument
       @debugger = GeekDict.debugger
       
+      # Use the provided model, or fallback to a default if nil (though CLI should provide one)
+      effective_model = model || 'google/gemini-2.5-flash-preview' # Fallback, though CLI provides default
+
       client = HTTPClient.new
       headers = {
         'Content-Type' => 'application/json',
@@ -15,7 +19,7 @@ module GeekDict
       }
       
       body = {
-        model: 'openai/o3-mini',
+        model: effective_model, # Use the determined model
         messages: [
           { role: "system", content: system_prompt(word) },
           { role: "user", content: word }
@@ -60,4 +64,4 @@ module GeekDict
       EOS
     end
   end
-end
+end

data/lib/geekdict/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geekdict
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Wenbing Li
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 2025-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -110,6 +110,7 @@ files:
 - geekdict.gemspec
 - lib/geekdict.rb
 - lib/geekdict/cli.rb
+- lib/geekdict/config.rb
 - lib/geekdict/debugger.rb
 - lib/geekdict/local_history.rb
 - lib/geekdict/openai/gpt.rb
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A command line tool for translation.