cocoapods-mapfile 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e843368c99922210970ea7de9ab8d2bcc895a158901d054a1cd076d29d73310
-  data.tar.gz: 8f7430064b4472cb4fd6c9fa42dfdd7a144d314c702ab7500a42b0ff302d9ab5
+  metadata.gz: 8eb57eb32ca81d86a3af1b1fa9b49115c3a7607bf1e6c2c546060e865a855652
+  data.tar.gz: 78ce44dbd5d258ffa4baa8d27201447fc8c2c995163239ec48cdc163fa1ab661
 SHA512:
-  metadata.gz: e1b0fbf54c2976dd6f7fcba6eca0d1d421a1df6360216e2049643d6ec1133592f19ce49786f58d0c100d71ce923492cf0135be75cbffbaae6e5a40f8b2a1c749
-  data.tar.gz: 9429682a00e5c633baf19f845f691b7fd64b6fa687af9afcb776b5beb86245338e5d1b2d910482809f66d91f660fb02e69c6ce1d3026922f1c6cf447e4345d0d
+  metadata.gz: e5acfc25fe04df059e746b82d1e4d6661ef598a378a19790bad48b04f5b10e11ad3e975bb61aa38b53a801bfe98234ed526744090be4cbb6477de4f982dce515
+  data.tar.gz: 73714efd5ea58856fd5170f2df67a036a15c9581bd5b4fd935f416b1508bf8b41d50f1e220d1cf81930891fb010ad3552583ee9925f8011801ca57feac14f18d

data/README.md

@@ -7,23 +7,21 @@ A CocoaPods plugin which can gen/read header map file.
 **hmap-gen** is able to scan the header files of the target referenced components in the specified Cocoapods project, and generates a header map file that public to all the components
 as well as generates a public and private header map file for each referenced component.
 
-    - `<header.h>` : -I<hmap file path>
-    - `header.h` : iquote <hmap file path>
+- <header.h> : -I<hmap file path>
+- "header.h" : -iquote <hmap file path>
 
 For framework, use [yaml-vfs](https://github.com/Cat1237/yaml-vfs) create VFS file to map framework Headers and Modules dir and pass VFS file to `-ivfsoverlay` parameter.
 
-A hmap file includes four types of headers:
-
-    - header.h
-    - <module/header.h> **based on podspec**
-    - <project_name/header.h> **based on podspec**
-    - <podspec source header/**/header.h> **based on podspec**
-
-At the same time, **hmap-reader** can read the header, bucktes, string_table information saved in the header map file.
+- vfs : -ivfsoverlay <all-product-headers.yaml>
 
-- ✅ It can read hmap file.
+A hmap file includes four types of headers:
 
-- ✅ It can generate header map file.
+- "header.h"
+- <module/header.h> **based on project**
+- <project_name/header.h> **based on project**
+- <*\*/**/header.h> **based on project**
+- "*\*/**/header.h" **based on project**
+- "module/header.h" **based on project**
 
 ## Installation
 
@@ -47,56 +45,95 @@ Or install it yourself as:
 $ gem install cocoapods-mapfile
 ```
 
-## Usage
+## Quickstart
+To begin gen hmap file by opening an Xcodeproj dir, and to your command line with:
+```shell
+$ hmapfile gen
+```
+or to your podfile, add this line:
+```
+$ plugin 'cocoapods-mapfile'
+```
+
+
+## Command Line Tool
+
+Installing the `cocoapods-mapfile` gem will also install two command-line tool `hmapfile reader` and `hmapfile writer` which you can use to generate header map file and read hmap file.
+
+For more information consult
+- `hmapfile --help`
+- `hmapfile gen --help`
+- `hmapfile reader --help`
+- `hmapfile writer --help`
+
+### Usage
+
+```shell
+
+# Read or write header map file.
+$ hmapfile COMMAND
+
+```
+
+#### Commands
+
+1. `hmapfile gen`:
+
+    - `--project-directory=/porject/dir`: Read .xcworkspace/.xcodeproj file to gen hmap files.
+    - `--clean-hmap`: Clean up hmap file settings.
 
-The command should be executed in directory that contains podfile.
+2. `hmapfile reader`:
+    - `--hmap-path=/hmap/dir/file`: Read this path of the hmap file.
+
+3. `hmapfile writer`:
+    - `--json-path=/project/dir/json`: The path to the hmap json data.
+    - `--output-path=/project/dir/hmap file`: The path json data to the hmap file.
+
+example：
 
 ```shell
-# write the hmap file to podfile/Pods/Headers/HMap
-$ pod hmap-gen
+# Read current dir .xcworkspace/.xcodeproj file to Gen hmap files.
+$ hmapfile gen
 
-# write the hmap file to /project/dir/Pods/Headers/HMap
-$ pod hmap-gen --project-directory=/project/dir/
+# Read the specified directory .xcworkspace/.xcodeproj file to Gen hmap files.
+$ hmapfile gen --project-directory=<project path>
 
-# write the hmap file to /project/dir/Pods/Headers/HMap and no save origin [HEADER_SEARCH_PATHS]
-$ pod hmap-gen --project-directory=/project/dir/ --nosave-origin-header-search-paths
+# Clean up hmap file settings.
+$ hmapfile gen --clean-hmap
+$ hmapfile gen --project-directory=<project path> --clean-hmap
 
-# cleanup the hmap file
-$ pod hmap-gen --clean-hmap
+$ hmapfile writer --json-path=../cat.json --output-path=../cat.hmap
 
-# read the hmap file from /hmap/dir/file
-$ pod hmap-reader --hmap-path=/hmap/dir/file
+$ hmapfile reader --hmap-path=../cat.hmap
 ```
 
-At same time, you can put this line in your podfile:
+## For Cocoapods
+
+Add this line in your podfile:
 
 ```rb
 plugin 'cocoapods-mapfile'
 ```
+
 This was equl:
+
 ```rb
-pod hmap-gen --project-directory=/project/dir/ 
+$ hmapfile gen --project-directory=<project path>
 ```
+or, you can set some value:
 
-Every time you execute pod install or pod update, `cocoapods-mapfile` will automatically generate a `header map file` for you and modify `HEAD_SEARCH_PATHS`.
-
-### Option && Flags
-
-`hmap-gen/hmap-writer`:
-
-- `--project-directory=/project/dir/`: The path to the root of the project directory.
-- `--nosave-origin-header-search-paths`: This option will not save xcconfig origin [HEADER_SEARCH_PATHS] and put `hmap file path` first.
-- `--clean-hmap`: This option will clean up all `hmap-gen/hmap-writer` setup for hmap.
-
-`hmap-reader`:
-
-- `--hmap-path=/hmap/dir/file`: The path of the hmap file.
-
-## Command Line Tool
+Every time you execute pod install or pod update, `cocoapods-mapfile` will automatically generate a `header map file` for you and modify:
+- `OTHER_CPLUSPLUSFLAGS`
+- `OTHER_CFLAGS`
+- `USE_HEADERMAP`
+- `USER_HEADER_SEARCH_PATHS`
+- `HEAD_SEARCH_PATHS`
 
-Installing the 'cocoapods-mapfile' gem will also install two command-line tool `hmap_reader` and `hmap-writer` which you can use to generate header map file and read hmap file.
+## TODO
 
-For more information consult `hmap_reader --help` or `hmap_writer --help`.
+- File generation speed
+- Perfect interface
+- Optimize the code
 
 ## Contributing
 

data/bin/{hmap_writer → hmapfile}

@@ -6,6 +6,6 @@ if $PROGRAM_NAME == __FILE__
   require 'bundler/setup'
 end
 
-require 'cocoapods-hmap/command/hmap_gen'
+require 'hmap'
 
-Pod::Command::HMapGen.run(ARGV)
+HMap::Command.run(ARGV)

data/lib/cocoapods_plugin.rb

@@ -1,13 +1,25 @@
 # frozen_string_literal: true
 
-require 'cocoapods-hmap/command/hmap_gen'
-require 'cocoapods-hmap/command/hmap_reader'
+require 'hmap'
 
 module Pod
   # hook
-  module CocoaPodsHMapHook
-    HooksManager.register('cocoapods-mapfile', :post_install) do
-      Command::HMapGen.run(["--project-directory=#{Config.instance.installation_root}"])
-    end
+  @HooksManager = HooksManager
+  @HooksManager.register('cocoapods-mapfile', :post_install) do |_, _options|
+    args = ['gen', "--project-directory=#{Config.instance.installation_root}"]
+    # allow_targets = options['allow_targets']
+    # unless allow_targets.nil?
+    #   if allow_targets.is_a?(Array)
+    #     args << "--allow-targets=#{allow_targets.join(', ')}" unless allow_targets.empty?
+    #   else
+    #     print 'waring:'.yellow, \
+    #           'plugin cocoapods-mapfile args allow_targets must be a array, like ## allow_targets: [target1, targte2] ##'
+    #   end
+    # end
+    # save_origin = options['save_oripodgin'].nil? ? true : options['save_origin']
+    # use_origin_headermap = options['use_origin_headermap'].nil? ? true : options['use_origin_headermap']
+    # args << '--fno-save-origin' unless save_origin
+    # args << '--fno-use-origin-headermap' unless use_origin_headermap
+    HMap::Command.run(args)
   end
 end

data/lib/hmap/command/hmap_gen.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module HMap
+  class Command
+    # hmap file gen cmd
+    class Gen < Command
+      # summary
+      self.summary = 'Analyzes the dependencies and gen each dependencie hmap file.'
+
+      self.description = <<-DESC
+      Analyzes the dependencies of any projects and gen each dependencie hmap file.
+      DESC
+
+      self.arguments = [
+        CLAide::Argument.new('--project-directory', false),
+        CLAide::Argument.new('--clean-hmap', false)
+      ]
+
+      def initialize(argv)
+        super
+        project_directory = argv.option('project-directory')
+        @clean_hmap = argv.flag?('clean-hmap', false)
+        project_directory = Dir.pwd if project_directory.nil?
+        @project_directory = Pathname.new(project_directory).expand_path
+      end
+
+      def validate!
+        super
+        if @project_directory.nil?
+          help! 'error: no input project directory which to use with the `--project-directory` option.'
+        end
+      end
+
+      # help
+      def self.options
+        [
+          ['--project-directory=/project/dir/', 'The path to the root of the project directory'],
+          ['--clean-hmap', 'This option will clean up all hmap-gen setup for hmap.']
+        ].concat(super)
+      end
+
+      def run
+        name = 'Gen'
+        name = 'Clean' if @clean_hmap
+        UserInterface.puts("\n[hmapfile] #{name} start..............")
+        HMap::MapFileWriter.new(true, @project_directory, @clean_hmap)
+        UserInterface.puts("[hmapfile] #{name} finish..............")
+      end
+    end
+  end
+end
+ 

data/lib/{cocoapods-hmap → hmap}/command/hmap_reader.rb

@@ -1,27 +1,31 @@
 # frozen_string_literal: false
 
-require 'cocoapods_hmap'
-require 'cocoapods'
-
-module Pod
+module HMap
   class Command
     # hmap file reader cmd
-    class HMapReader < Command
+    class Reader < Command
       self.summary = 'Read mapfile and puts result.'
 
       self.description = <<-DESC
       Read mapfile and puts result, header, buckets, string_table.
       DESC
 
+      self.arguments = [
+        # framework_p, r_header, r_m
+        CLAide::Argument.new('--hmap-path', true)
+      ]
+
       def initialize(argv)
         super
         mapfile_path = argv.option('hmap-path')
-        @mapfile_path = Pathname.new(mapfile_path).expand_path unless mapfile_path.nil?
+        raise ArgumentError, "#{mapfile_path}: no such file!" if mapfile_path.nil? || !File.exist?(mapfile_path)
+
+        @mapfile_path = Pathname.new(mapfile_path).expand_path 
       end
 
       def validate!
         super
-        banner! if help?
+        # banner! if help?
         raise '[ERROR]: --hmap-path no set'.red unless File.exist?(@mapfile_path)
       end
 
@@ -32,10 +36,9 @@ module Pod
       end
 
       def run
-        UI.section "\n[hmap-reader] start..............\n".yellow do
-          HMap::MapFileReader.new(@mapfile_path)
-        end
-        UI.puts("\n[hmap-reader] finish..............\n".yellow)
+        UserInterface.puts "\n[hmapfile] Reader start..............\n".yellow
+        HMap::MapFileReader.new(@mapfile_path)
+        UserInterface.puts "\n[hmapfile] Reader finish..............\n".yellow
       end
     end
   end

data/lib/hmap/command/hmap_writer.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module HMap
+  class Command
+    # hmap file gen cmd
+    class Writer < Command
+      # summary
+      self.summary = 'Analyzes the input json and gen each dependencie mapfile.'
+
+      self.description = <<-DESC
+      Analyzes the input json and gen each dependencie mapfile.
+      DESC
+
+      self.arguments = [
+        # framework_p, r_header, r_m
+        CLAide::Argument.new('--json-path', true),
+        CLAide::Argument.new('--output-path', false)
+      ]
+
+      def initialize(argv)
+        super
+        json_path = argv.option('json-path')
+        @json_path = json_path unless json_path.nil?
+        output_path = argv.option('output-path')
+        @output_path = output_path.nil? ? Pathname('.') : Pathname(output_path)
+      end
+
+      def validate!
+        super
+        help! 'error: no input json files which to use with the `--json-path` option.' if @json_path.nil?
+        help! "error: Input json file #{@json_path}: no such file" unless File.exist?(@json_path)
+      end
+
+      # help
+      def self.options
+        [
+          ['--json-path=/project/dir/json', 'The path to the hmap json data.'],
+          ['--output-path=/project/dir/hmap file', 'The path json data to the hmap file.']
+        ].concat(super)
+      end
+
+      def run
+        require 'json'
+        UserInterface.puts "\n[hmapfile-from-json] start..............".yellow
+        json_file = File.read(@json_path)
+        json = JSON.parse(json_file)
+        strs = json.map { |e| HMap::BucketStr.new(*e) }
+        path = @output_path
+        path = path.join("#{File.basename(@json_path, '.*')}.hmap") if path.directory?
+        HMapSaver.new_from_buckets(strs).write_to(path)
+        UserInterface.puts '[hmapfile-from-json] finish..............'.yellow
+      end
+    end
+  end
+end

data/lib/hmap/command.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# The primary namespace for VFS.
+module HMap
+  require 'colored2'
+  require 'claide'
+  # The primary Command for VFS.
+  class Command < CLAide::Command
+    require 'hmap/command/hmap_writer'
+    require 'hmap/command/hmap_reader'
+    require 'hmap/command/hmap_gen'
+
+
+    self.abstract_command = false
+    self.command = 'hmapfile'
+    self.version = VERSION
+    self.description = 'Read or write header map file.'
+    self.plugin_prefixes = %w[claide writer reader gen]
+
+    def initialize(argv)
+      super
+      return if ansi_output?
+
+      Colored2.disable!
+      String.send(:define_method, :colorize) { |string, _| string }
+    end
+  end
+end

data/lib/hmap/constants.rb

@@ -0,0 +1,198 @@
+module HMap
+  # This modules groups all the constants known to HMap.
+  #
+  class Constants
+    BUILD_DIR = 'BUILD_DIR'
+    BUILD_DIR_KEY = '${BUILD_DIR}'
+    OBJROOT = 'OBJROOT'
+    SRCROOT = '${SRCROOT}'
+    HMAP_DIR = 'HMap'
+    HMAP_GEN_DIR = 'HMAP_GEN_DIR'
+    HMAP_GEN_DIR_VALUE = '${HMAP_GEN_DIR}'
+    XCBuildData = 'XCBuildData'
+    PROJECT_TEMP_DIR = '${PROJECT}.build'
+    TARGET_TEMP_DIR = '${TARGET_NAME}.build'
+    TARGET_NAME = '${TARGET_NAME}'
+    PRODUCT_NAME = 'PRODUCT_NAME'
+    PRODUCT_NAME_VALUE = '${PRODUCT_NAME}'
+    CONFIGURATION_EFFECTIVE_PLATFORM = '$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)'
+    USE_HEADERMAP = 'USE_HEADERMAP'
+    USER_HEADER_SEARCH_PATHS = 'USER_HEADER_SEARCH_PATHS'
+    HEADER_SEARCH_PATHS = 'HEADER_SEARCH_PATHS'
+    HMAP_HEADER_SETTING = 'HMAP_HEADER_SETTING'
+    HMAP_HEADER_SETTING_KEY = '${HMAP_HEADER_SETTING}'
+
+    OTHER_CFLAGS = 'OTHER_CFLAGS'
+    OTHER_CPLUSPLUSFLAGS = 'OTHER_CPLUSPLUSFLAGS'
+    CONFIGURATION_BUILD_DIR = 'CONFIGURATION_BUILD_DIR'
+
+    XCBuildConfiguration = Xcodeproj::Project::Object::XCBuildConfiguration
+    PBXSourcesBuildPhase = Xcodeproj::Project::Object::PBXSourcesBuildPhase
+    PBXHeadersBuildPhase = Xcodeproj::Project::Object::PBXHeadersBuildPhase
+    PBXGroup = Xcodeproj::Project::Object::PBXGroup
+    PBXFileReference = Xcodeproj::Project::Object::PBXFileReference
+    PBXBuildFile = Xcodeproj::Project::Object::PBXBuildFile
+    PBXAggregateTarget = Xcodeproj::Project::Object::PBXAggregateTarget
+
+    HMAP_TARGET_ROOT = [BUILD_DIR_KEY, '..', '..', HMAP_DIR,
+                        PROJECT_TEMP_DIR, CONFIGURATION_EFFECTIVE_PLATFORM,
+                        TARGET_TEMP_DIR].join('/')
+
+    HMAP_GEN_DIR_ATTRIBUTE = { HMAP_GEN_DIR => HMAP_TARGET_ROOT }
+
+    HMAP_FILE_TYPE = %i[own_target_headers all_non_framework_target_headers all_target_headers all_product_headers
+                        project_headers workspace_headers]
+
+    def self.instance
+      @instance ||= new
+    end
+
+    # Sets the current config instance. If set to nil the config will be
+    # recreated when needed.
+    #
+    # @param  [Config, Nil] the instance.
+    #
+    # @return [void]
+    #
+    class << self
+      attr_writer :instance
+    end
+
+    # def full_product_name(name, type)
+    #   name.join('.', FILE_TYPES_BY_EXTENSION[type])
+    # end
+
+    def hmap_filename(type)
+      filenames[type]
+    end
+
+    def full_hmap_filename(type, product_name = nil)
+      name = hmap_filename(type)
+      name = "#{product_name}-#{name}" if type != :all_product_headers && !product_name.nil?
+      name
+    end
+
+    def full_hmap_filepath(type, path, dir = nil, product_name = nil)
+      name = full_hmap_filename(type, product_name) unless path.end_with?(hmap_filename(type))
+      path = Pathname.new(path)
+      path = path.join(dir) unless dir.nil?
+      path = path.join(name) unless name.nil?
+      path
+    end
+
+    def hmap_build_setting_key(type)
+      build_setting_keys(type)
+    end
+
+    def hmap_build_setting_values
+      ss = build_setting_values.values.join(' ')
+      ['$(inherited)', ss].join(' ')
+    end
+
+    def hmap_build_setting_value(type)
+      build_setting_values[type]
+    end
+
+    def hmap_xc_filename(type)
+      xc_filenames[type]
+    end
+
+    def hmap_build_settings
+      build_settings
+    end
+
+    private
+
+    def build_settings
+      return @build_settings if defined? @build_settings
+
+      attributes = HMAP_GEN_DIR_ATTRIBUTE
+      settings = hmap_build_setting_values
+      #   attributes[HMAP_HEADER_SETTING] = settings
+      attributes[HEADER_SEARCH_PATHS] = build_setting_values_i
+      attributes[OTHER_CFLAGS] = build_setting_values_c
+      attributes[OTHER_CPLUSPLUSFLAGS] = build_setting_values_c
+      attributes[USER_HEADER_SEARCH_PATHS] = build_setting_values_iquote
+      #   attributes[OTHER_CFLAGS] = HMAP_HEADER_SETTING_KEY
+      #   attributes[OTHER_CPLUSPLUSFLAGS] = HMAP_HEADER_SETTING_KEY
+      attributes[USE_HEADERMAP] = 'NO'
+      @build_settings = attributes
+    end
+
+    def filenames
+      return @filenames if defined? @filenames
+
+      @filenames = Hash[HMAP_FILE_TYPE.map do |type|
+        t_type = type
+        t_type = :all_target_headers if type == :workspace_headers
+        name = t_type.to_s.gsub(/_/, '-')
+        extname = '.hmap'
+        extname = '.yaml' if type == :all_product_headers
+        [type, name + extname]
+      end]
+    end
+
+    def build_setting_values_i
+      %i[own_target_headers all_non_framework_target_headers].map do |type|
+        value = xc_filenames[type]
+        "\"#{HMAP_GEN_DIR_VALUE}/#{value}\""
+      end.join(' ')
+    end
+
+    def build_setting_values_iquote
+      %i[project_headers all_target_headers].map do |type|
+        value = xc_filenames[type]
+        "\"#{HMAP_GEN_DIR_VALUE}/#{value}\""
+      end.join(' ')
+    end
+
+    def build_setting_values_c
+      %i[all_target_headers all_product_headers].map do |type|
+        key = build_setting_keys[type]
+        value = xc_filenames[type]
+        blank = ' ' unless key == :I
+        ["-#{key}", "\"#{HMAP_GEN_DIR_VALUE}/#{value}\""].join(blank || '')
+      end.join(' ')
+    end
+
+    def build_setting_keys
+      return @build_setting_keys if defined? @build_setting_keys
+
+      @build_setting_keys =
+        Hash[HMAP_FILE_TYPE.map do |type|
+               [type, case type
+                      when :workspace_headers, :project_headers then :iquote
+                      when :all_product_headers then :ivfsoverlay
+                      else
+                        :I
+                      end]
+             end]
+    end
+
+    def build_setting_values
+      return @build_setting_values if defined? @build_setting_values
+
+      @build_setting_values =
+        Hash[HMAP_FILE_TYPE.map do |type|
+               key = build_setting_keys[type]
+               value = xc_filenames[type]
+               blank = ' ' unless key == :I
+               [type, ["-#{key}", "\"#{HMAP_GEN_DIR_VALUE}/#{value}\""].join(blank || '')]
+             end]
+    end
+
+    def xc_filenames
+      return @xc_filenames if defined? @xc_filenames
+
+      @xc_filenames =
+        Hash[HMAP_FILE_TYPE.map do |type|
+               file_name = filenames[type]
+               [type, case type
+                      when :all_product_headers then file_name
+                      else
+                        "#{Constants::PRODUCT_NAME_VALUE}-#{file_name}"
+                      end]
+             end]
+    end
+  end
+end

data/lib/{cocoapods-hmap → hmap/helper}/executable.rb

@@ -44,10 +44,10 @@ module HMap
       end
       full_command = "#{bin} #{command.join(' ')}"
 
-      if Pod::Config.instance.verbose?
+      if Resolver.instance.verbose?
         p("$ #{full_command}")
-        stdout = Indenter.new(STDOUT)
-        stderr = Indenter.new(STDERR)
+        stdout = Indenter.new($stdout)
+        stderr = Indenter.new($stderr)
       else
         stdout = Indenter.new
         stderr = Indenter.new
@@ -64,7 +64,6 @@ module HMap
           p("[!] Failed: #{full_command}".red)
         end
       end
-
       stdout
     end
 
@@ -185,8 +184,8 @@ module HMap
               output << (string << separator)
             end
           end
-        rescue EOFError, IOError
-          output << (buf << $/) unless buf.empty?
+        rescue IOError, EOFError
+          output << (buf << $RS) unless buf.empty?
         end
       end
     end

data/lib/{cocoapods-hmap → hmap/helper}/utils.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: false
 
-require 'cocoapods'
-
 module HMap
   # A collection of utility functions used throughout cocoapods-hmap.
   module Utils
@@ -94,5 +92,3 @@ module HMap
     end
   end
 end
-
-

data/lib/hmap/hmap/hmap_bucketstr.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module HMap
+  # hmap bucket string
+  class BucketStr
+    attr_reader :key, :perfix, :suffix
+
+    def initialize(key, perfix, suffix)
+      @key = key
+      @perfix = perfix
+      @suffix = suffix
+    end
+
+    def description
+      <<-DESC
+        Key #{@key} -> Prefix #{@perfix}, Suffix #{@suffix}
+      DESC
+    end
+  end
+end