Code Monkey home page Code Monkey logo

ifacemaker's Introduction

ifacemaker Build Status

This is a development helper program that generates a Golang interface by inspecting the structure methods of an existing .go file. The primary use case is to generate interfaces for gomock, so that gomock can generate mocks from those interfaces. This makes unit testing easier.

Install

go get github.com/vburenin/ifacemaker

Usage

Here is the help output of ifacemaker:

$ ifacemaker --help
Usage:
  ifacemaker [OPTIONS]

Application Options:
  -f, --file=          Go source file to read
  -s, --struct=        Generate an interface for this structure name
  -i, --iface=         Name of the generated interface
  -p, --pkg=           Package name for the generated interface
  -y, --iface-comment= Comment for the interface, default is '// <iface> ...'
  -d, --doc=           Copy docs from methods (default: true)
  -D, --type-doc       Copy type doc from struct
  -c, --comment=       Append comment to top
  -o, --output=        Output file name. If not provided, result will be printed to stdout.

Help Options:
  -h, --help           Show this help message
$

As an example, let's say you wanted to generate an interface for the Human structure in this sample code:

package main

import "fmt"

type Human struct {
	name string
	age  int
}

// Returns the name of our Human.
func (h *Human) GetName() string {
	return h.name
}

// Our Human just had a birthday! Increase its age.
func (h *Human) Birthday() {
	h.age += 1
	fmt.Printf("I am now %d years old!\n", h.age)
}

// Make the Human say hello.
func (h *Human) SayHello() {
	fmt.Printf("Hello, my name is %s, and I am %d years old.\n", h.name, h.age)
}

func main() {
	human := &Human{name: "Bob", age: 30}
	human.GetName()
	human.SayHello()
	human.Birthday()
}

The ifacemaker helper program can generate this interface for you:

$ ifacemaker -f human.go -s Human -i HumanIface -p humantest -y "HumanIface makes human interaction easy" -c "DONT EDIT: Auto generated"
// DONT EDIT: Auto generated

package humantest

// HumanIface makes human interaction easy
type HumanIface interface {
	// Returns the name of our Human.
	GetName() string
	// Our Human just had a birthday! Increase its age.
	Birthday()
	// Make the Human say hello.
	SayHello()
}

$

In the above example, ifacemaker inspected the structure methods of the Human struct and generated an interface called HumanIface in the humantest package. Note that the ifacemaker program preserves docstrings by default.

You can tell ifacemaker to write its output to a file, versus stdout, using the -o parameter:

$ ifacemaker -f human.go -s Human -i HumanIface -p humantest -y "HumanIface makes human interaction easy" -c "DONT EDIT: Auto generated" -o humaniface.go
$

ifacemaker's People

Contributors

markus-wa avatar nkovacs avatar vburenin avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.