cocoapods-mapfile 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7638b72b3d9fe0246d6dd7a06aba65b29ad95ccc30fdf7567626141f90c58d43
-  data.tar.gz: 62b76aa9a97ada6c2e0e187092c2c8ad669e1d55bd07e6efe0f95f00cc0ba5a1
+  metadata.gz: cd22ad1c9300a50d1e79ad4e19c349784d632ef50766b00741faad26d4e350a4
+  data.tar.gz: 425b0e5b884e3eaa4ad9f9f60bdc8680e5a4d4573e72e97af2f2f0707305e0e9
 SHA512:
-  metadata.gz: 723055fb0d1a47079499121296b2c0236f007a96a6cc023f6518a1888a3cb0d87e09de92dc6a820193187e1b9e3e8cdfc5d7c4d6fa2820942768b4972ddde1a7
-  data.tar.gz: 05d078150dca66846048b6dc73b29e2c6dd8d8e182bf1504dd3a17b973cd5101c2429d8c63cbd0d4d886ef92d920116481415c56542f1ae4adeda7574b48691d
+  metadata.gz: bad97e72c3cde2ae26a510a8f1e3cf97e0f60ab219f187d440658950a47d0d9a46af541bfa18f46a9e37f2bec39512e84e3da7aa750a9e04bfe1f5963216e729
+  data.tar.gz: 96a82f5e9926050be9cb1fb4c225cdd5b54a0ae4c5e982736680bf97558145a2f1a5ca1058259d4ba366272bb073abcca9d96c3020cce7847cb16408db3821a2

data/README.md

@@ -7,19 +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.
 
-    - vfs : -ivfsoverlay <all-product-headers.yaml>
+- vfs : -ivfsoverlay <all-product-headers.yaml>
 
 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**
+- "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
 
@@ -43,91 +45,90 @@ Or install it yourself as:
 $ gem install cocoapods-mapfile
 ```
 
-## Usage
-
-The command should be executed in directory that contains podfile.
-
+## Quickstart
+To begin gen hmap file by opening an Xcodeproj dir, and to your command line with:
 ```shell
-# write the hmap file to podfile/Pods/Headers/HMap
-$ pod hmap-gen
-
-# write the hmap file to /project/dir/Pods/Headers/HMap
-$ pod hmap-gen --project-directory=/project/dir/
-
-# 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
-
-# cleanup the hmap file
-$ pod hmap-gen --clean-hmap
-
-# no keep xcconfig file [HEADER_SEARCH_PATHS] and [USER_HEADER_SEARCH_PATHS] value
-$ pod hmap-gen --fno-save-origin
-
-# ⚠️no keep xcconfig file [HEADER_SEARCH_PATHS] and [USER_HEADER_SEARCH_PATHS] value, except for the values ​​set by[--allow-targets]
-$ pod hmap-gen --fno-save-origin --allow-targets=Realm, YYKit
-
-# not use automatically generated hmap file from Xcode， use [hmap-gen]
-$ pod hmap-gen --fno-use-origin-headermap
-
-# read the hmap file from /hmap/dir/file
-$ pod hmap-reader --hmap-path=/hmap/dir/file
-```
-
-```rb
-plugin 'cocoapods-mapfile'
-```
-This was equl:
-```rb
-$ pod hmap-gen --project-directory=/project/dir/ 
+$ hmapfile gen
 ```
-or, you can set some value:
-
-```rb
-plugin('cocoapods-mapfile', allow_targets: ['Realm', 'YYKit'], save_origin: false, use_origin_headermap: false)
+or to your podfile, add this line:
 ```
-This was equl:
-```rb
-$ pod hmap-gen --fno-save-origin --fno-use-origin-headermap --allow-targets=Realm, YYKit
+$ plugin 'cocoapods-mapfile'
 ```
 
-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`
 
 ## 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`,
+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
-`hmapfile reader`:
-- `--hmap-path=/hmap/dir/file`: Read this path of the hmap file.
 
-`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.
+1. `hmapfile gen`:
+
+    - `--project-directory=/porject/dir`: Read .xcworkspace/.xcodeproj file to gen hmap files.
+    - `--clean-hmap`: Clean up hmap file settings.
+
+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
-hmapfile writer --json-path=../cat.json --output-path=../cat.hmap
+# Read current dir .xcworkspace/.xcodeproj file to Gen hmap files.
+$ hmapfile gen
+
+# Read the specified directory .xcworkspace/.xcodeproj file to Gen hmap files.
+$ hmapfile gen --project-directory=<project path>
+
+# Clean up hmap file settings.
+$ hmapfile gen --clean-hmap
+$ hmapfile gen --project-directory=<project path> --clean-hmap
 
-hmapfile reader --hmap-path=../cat.hmap
+$ hmapfile writer --json-path=../cat.json --output-path=../cat.hmap
+
+$ hmapfile reader --hmap-path=../cat.hmap
+```
+
+## For Cocoapods
+
+Add this line in your podfile:
+
+```rb
+plugin 'cocoapods-mapfile'
 ```
 
+This was equl:
+
+```rb
+$ 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:
+- `OTHER_CPLUSPLUSFLAGS`
+- `OTHER_CFLAGS`
+- `USE_HEADERMAP`
+- `USER_HEADER_SEARCH_PATHS`
+- `HEAD_SEARCH_PATHS`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [cocoapods-hmap](https://github.com/Cat1237/cocoapods-hmap). This project is intended to be a safe, welcoming space for collaboration.

data/lib/cocoapods_plugin.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
-require 'hmap/command/hmap_gen'
+require 'hmap'
 
 module Pod
   # hook
   module CocoaPodsHMapHook
     @HooksManager = HooksManager
     @HooksManager.register('cocoapods-mapfile', :post_install) do |_, options|
-      args = ["--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
-      Command::HMapGen.run(args)
+      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
 end

data/lib/hmap/command/hmap_gen.rb

@@ -1,60 +1,52 @@
 # frozen_string_literal: true
 
-require 'hmap'
-
-module Pod
+module HMap
   class Command
     # hmap file gen cmd
-    class HMapGen < Command
+    class Gen < Command
       # summary
-      self.summary = 'Analyzes the dependencies and gen each dependencie mapfile.'
+      self.summary = 'Analyzes the dependencies and gen each dependencie hmap file.'
 
       self.description = <<-DESC
-      Analyzes the dependencies of any cocoapods projects and gen each dependencie mapfile.
+      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')
-        targets = argv.option('allow-targets') || ''
-        @allow_targets = targets.split(%r{,\s*})
-        @no_use_build_in_headermap = !argv.flag?('fno-use-origin-headermap', false)
-        @save_origin_build_setting = !argv.flag?('fno-save-origin', false)
         @clean_hmap = argv.flag?('clean-hmap', false)
-        return if project_directory.nil?
-
+        project_directory = Dir.pwd if project_directory.nil?
         @project_directory = Pathname.new(project_directory).expand_path
-        config.installation_root = @project_directory
       end
 
       def validate!
         super
-        verify_podfile_exists!
+        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'],
-          ['--allow-targets=target, target1, target2', 'If we set --fno-use-origin-headermap and ' \
-            '--fno-save-origin, we can use this option to decide which targets to use hmap file while keeping the initial settings'],
-          ['--fno-save-origin',
-           'This option will not save xcconfig origin [HEADER_SEARCH_PATHS] and put hmap file first'],
-          ['--fno-use-origin-headermap',
-           'This option will use  Xcode built-in options Use Header Maps and not use this code gen hmap file'],
           ['--clean-hmap', 'This option will clean up all hmap-gen setup for hmap.']
         ].concat(super)
       end
 
       def run
-        UI.section "\n[hmap-gen] start.............." do
-          HMap::MapFileWriter.new(@save_origin_build_setting,
-                                  @clean_hmap,
-                                  @allow_targets,
-                                  use_build_in_headermap: @no_use_build_in_headermap)
-        end
-        UI.puts('[hmap-gen] finish..............')
+        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/hmap/command/hmap_reader.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: false
 
-require 'hmap'
-
 module HMap
   class Command
     # hmap file reader cmd
@@ -20,7 +18,9 @@ module HMap
       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!
@@ -36,9 +36,9 @@ module HMap
       end
 
       def run
-        puts "\n[hmap-reader] start..............\n".yellow
+        UserInterface.puts "\n[hmapfile] Reader start..............\n".yellow
         HMap::MapFileReader.new(@mapfile_path)
-        puts "\n[hmap-reader] finish..............\n".yellow
+        UserInterface.puts "\n[hmapfile] Reader finish..............\n".yellow
       end
     end
   end

data/lib/hmap/command/hmap_writer.rb

@@ -40,13 +40,15 @@ module HMap
       end
 
       def run
-        puts "\n[hmap-gen-from-json] start..............".yellow
+        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(json).write_to(path)
-        puts '[hmap-gen-from-json] finish..............'.yellow
+        HMapSaver.new_from_buckets(strs).write_to(path)
+        UserInterface.puts '[hmapfile-from-json] finish..............'.yellow
       end
     end
   end

data/lib/hmap/command.rb

@@ -8,12 +8,14 @@ module HMap
   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]
+    self.plugin_prefixes = %w[claide writer reader gen]
 
     def initialize(argv)
       super

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/hmap/{executable.rb → 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/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